source: branches/2520_PersistenceReintegration/HeuristicLab.Core/3.3/Interfaces/IRandom.cs @ 16453

Last change on this file since 16453 was 16453, checked in by jkarder, 9 months ago

#2520: updated year of copyrights

File size: 2.4 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2019 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22namespace HeuristicLab.Core {
23  /// <summary>
24  /// Represents an interface for random number generators.
25  /// </summary>
26  public interface IRandom : IItem {
27    /// <summary>
28    /// Resets the random number generator.
29    /// </summary>
30    void Reset();
31    /// <summary>
32    /// Resets the random number generator with the given <paramref name="seed"/>.
33    /// </summary>
34    /// <param name="seed">The new seed.</param>
35    void Reset(int seed);
36
37    /// <summary>
38    /// Gets a new random number.
39    /// </summary>
40    /// <returns>A random integer number.</returns>
41    int Next();
42    /// <summary>
43    /// Gets a new random number between 0 and <paramref name="maxVal"/>.
44    /// </summary>
45    /// <param name="maxVal">The maximal value of the random number (exclusive).</param>
46    /// <returns>A random integer number smaller than <paramref name="maxVal"/>.</returns>
47    int Next(int maxVal);
48    /// <summary>
49    /// Gets a new random number between <paramref name="minVal"/> and <paramref name="maxVal"/>.
50    /// </summary>
51    /// <param name="maxVal">The maximal value of the random number (exclusive).</param>
52    /// <param name="minVal">The minimal value of the random number (inclusive).</param>
53    /// <returns>A random integer number. (<paramref name="minVal"/> &lt;= x &lt; <paramref name="maxVal"/>).</returns>
54    int Next(int minVal, int maxVal);
55    /// <summary>
56    /// Gets a new double random number.
57    /// </summary>
58    /// <returns>A random double number.</returns>
59    double NextDouble();
60  }
61}
Note: See TracBrowser for help on using the repository browser.