Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Core/Interfaces/IRandom.cs @ 1256

Last change on this file since 1256 was 817, checked in by vdorfer, 16 years ago

Created API documentation for HeuristicLab.Selection namespace (#331)

File size: 2.5 KB
RevLine 
[2]1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2008 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
22using System;
23using System.Collections.Generic;
24using System.Text;
25using HeuristicLab.Core;
26
27namespace HeuristicLab.Core {
[776]28  /// <summary>
29  /// Represents an interface for random number generators.
30  /// </summary>
[2]31  public interface IRandom : IItem {
[776]32    /// <summary>
33    /// Resets the random number generator.
34    /// </summary>
[2]35    void Reset();
[776]36    /// <summary>
37    /// Resets the random number generator with the given <paramref name="seed"/>.
38    /// </summary>
39    /// <param name="seed">The new seed.</param>
[2]40    void Reset(int seed);
41
[776]42    /// <summary>
43    /// Gets a new random number.
44    /// </summary>
45    /// <returns>A random integer number.</returns>
[2]46    int Next();
[776]47    /// <summary>
48    /// Gets a new random number between 0 and <paramref name="maxVal"/>.
49    /// </summary>
[817]50    /// <param name="maxVal">The maximal value of the random number (exclusive).</param>
51    /// <returns>A random integer number smaller than <paramref name="maxVal"/>.</returns>
[2]52    int Next(int maxVal);
[776]53    /// <summary>
54    /// Gets a new random number between <paramref name="minVal"/> and <paramref name="maxVal"/>.
55    /// </summary>
[817]56    /// <param name="maxVal">The maximal value of the random number (exclusive).</param>
57    /// <param name="minVal">The minimal value of the random number (inclusive).</param>
58    /// <returns>A random integer number. (<paramref name="minVal"/> &lt;= x &lt; <paramref name="maxVal"/>).</returns>
[2]59    int Next(int minVal, int maxVal);
[776]60    /// <summary>
61    /// Gets a new double random number.
62    /// </summary>
63    /// <returns>A random double number.</returns>
[2]64    double NextDouble();
65  }
66}
Note: See TracBrowser for help on using the repository browser.