https://github.com/neo-ciber94/extrautilsrandomizer
A pseudorandom number generator.
https://github.com/neo-ciber94/extrautilsrandomizer
Last synced: 8 months ago
JSON representation
A pseudorandom number generator.
- Host: GitHub
- URL: https://github.com/neo-ciber94/extrautilsrandomizer
- Owner: Neo-Ciber94
- Created: 2020-01-14T21:45:09.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-01-16T01:19:20.000Z (over 5 years ago)
- Last Synced: 2024-12-28T12:30:47.592Z (9 months ago)
- Language: C#
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## ExtraUtils.Randomizer
Contains the ``RNG`` struct that provides methods for generate pseudorandom
numbers using **shift-register generators** or **xorshift**.
_________________________________________
### Implementation
```csharp
public struct RNG
{
// A default RNG with a random seed
public static RNG Default { get; }
// Constructors
public RNG(uint seed);
public RNG(int seed);
// Pseudorandom int generators
public int NextInt();
public int NextInt(int max);
public int NextInt(int min, int max);
// Pseudorandom long generators
public long NextLong();
public long NextLong(long max);
public long NextLong(long min, long min);
// Pseudorandom uint generators
public uint NextUInt();
public uint NextUInt(uint max);
public uint NextUInt(uint min, uint max);
// Pseudorandom ulong generators
public ulong NextULong();
public ulong NextULong(ulong max);
public ulong NextULong(ulong min, ulong max);
// Pseudorandom float generators
public float NextFloat();
public float NextFloat(float max);
public float NextFloat(float min, float max);
// Pseudorandom double generators
public double NextDouble();
public double NextDouble(double max);
public double NextDouble(double min, double max);
// Pseudorandom bool generator
public bool NextBool();
// Pseudorandom bit generator
public int NextBits(int bitsCount);
// Pseudorandom char generators
public char NextChar();
public char NextChar(RandomCharKind charKind);
// Pseudorandom buffer generators
public void NextString(Span destination);
public void NextString(Span destination, RandomCharKind charKind);
public void NextBytes(Span destination);
}
```
_________________________________________
### Examples
Generate pseudorandom numbers
```csharp
// RNG namespace
using ExtraUtils.Randomizer;
// Creates a new RNG with '123' as seed
var rng = new RNG(123);
Console.WriteLine(rng.NextInt(0, 10)); // 4
Console.WriteLine(rng.NextLong()); // -2443414909555492944
Console.WriteLine(rng.NextBool()); // False
Console.WriteLine(rng.NextDouble()); // 0.4347246039820484
```
Generate pseudorandom strings or bytes using ``Span``
```csharp
// Creates a buffer for a pseudorandom string of 10 characters
Span myString = stackalloc char[10];
// Fills 'myString' with random characters
rng.NextString(myString);
Console.WriteLine(myString.ToString()); // F2WNYf2c5S
// Creates other buffer for pseudorandom bytes
Span myBytes = stackalloc byte[5];
// Fills 'myBytes' with random bytes
rng.NextBytes(myBytes);
// Helper method BytesToString prints the content of the Span
Console.WriteLine(BytesToString(span)); // [241, 12, 44, 206, 176]
```