Add random number generator

This commit is contained in:
Andrew Cooper
2022-03-02 21:45:42 +11:00
parent f61350ce04
commit 2c1e4af702
2 changed files with 105 additions and 0 deletions

View File

@@ -0,0 +1,55 @@
namespace Games.Common.Randomness;
/// <summary>
/// Provides access to a random number generator
/// </summary>
public interface IRandom
{
/// <summary>
/// Gets a random <see cref="float" /> such that 0 <= n < 1.
/// </summary>
/// <returns>The random number.</returns>
float NextFloat();
/// <summary>
/// Gets a random <see cref="float" /> such that 0 <= n < exclusiveMaximum.
/// </summary>
/// <returns>The random number.</returns>
float NextFloat(float exclusiveMaximum);
/// <summary>
/// Gets a random <see cref="float" /> such that inclusiveMinimum <= n < exclusiveMaximum.
/// </summary>
/// <returns>The random number.</returns>
float NextFloat(float inclusiveMinimum, float exclusiveMaximum);
/// <summary>
/// Gets a random <see cref="int" /> such that 0 <= n < exclusiveMaximum.
/// </summary>
/// <returns>The random number.</returns>
int Next(int exclusiveMaximum);
/// <summary>
/// Gets a random <see cref="int" /> such that inclusiveMinimum <= n < exclusiveMaximum.
/// </summary>
/// <returns>The random number.</returns>
int Next(int inclusiveMinimum, int exclusiveMaximum);
/// <summary>
/// Gets the previous random number as a <see cref="float" />.
/// </summary>
/// <returns>The previous random number.</returns>
float PreviousFloat();
/// <summary>
/// Gets the previous random number as an <see cref="int" />.
/// </summary>
/// <returns>The previous random number.</returns>
int Previous();
/// <summary>
/// Reseeds the random number generator.
/// </summary>
/// <param name="seed">The seed.</param>
void Reseed(int seed);
}