Free cookie consent management tool by TermsFeed Policy Generator

source: branches/PersistenceOverhaul/HeuristicLab.Core/3.3/Interfaces/IRandom.cs

Last change on this file was 14712, checked in by gkronber, 8 years ago

#2520 added GUIDs for (almost) all interface types (probably still too many) also added newlines at end of all files

File size: 2.5 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2015 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  [HeuristicLab.Persistence.Default.CompositeSerializers.Storable.StorableType("F3A14B84-FE84-42B7-9A2C-8526CED04FE0")]
27  public interface IRandom : IItem {
28    /// <summary>
29    /// Resets the random number generator.
30    /// </summary>
31    void Reset();
32    /// <summary>
33    /// Resets the random number generator with the given <paramref name="seed"/>.
34    /// </summary>
35    /// <param name="seed">The new seed.</param>
36    void Reset(int seed);
37
38    /// <summary>
39    /// Gets a new random number.
40    /// </summary>
41    /// <returns>A random integer number.</returns>
42    int Next();
43    /// <summary>
44    /// Gets a new random number between 0 and <paramref name="maxVal"/>.
45    /// </summary>
46    /// <param name="maxVal">The maximal value of the random number (exclusive).</param>
47    /// <returns>A random integer number smaller than <paramref name="maxVal"/>.</returns>
48    int Next(int maxVal);
49    /// <summary>
50    /// Gets a new random number between <paramref name="minVal"/> and <paramref name="maxVal"/>.
51    /// </summary>
52    /// <param name="maxVal">The maximal value of the random number (exclusive).</param>
53    /// <param name="minVal">The minimal value of the random number (inclusive).</param>
54    /// <returns>A random integer number. (<paramref name="minVal"/> &lt;= x &lt; <paramref name="maxVal"/>).</returns>
55    int Next(int minVal, int maxVal);
56    /// <summary>
57    /// Gets a new double random number.
58    /// </summary>
59    /// <returns>A random double number.</returns>
60    double NextDouble();
61  }
62}
Note: See TracBrowser for help on using the repository browser.