FastRng 1.1.1

There is a newer version of this package available.
See the version list below for details.

dotnet add package FastRng --version 1.1.1

NuGet\Install-Package FastRng -Version 1.1.1

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="FastRng" Version="1.1.1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add FastRng --version 1.1.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: FastRng, 1.1.1"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install FastRng as a Cake Addin
#addin nuget:?package=FastRng&version=1.1.1

// Install FastRng as a Cake Tool
#tool nuget:?package=FastRng&version=1.1.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

FastRng

FastRng is a multi-threaded pseudo-random number generator. Besides the generation of uniformly distributed random numbers, there are several other distributions to choose from. For performance reasons the parameters of the distributions are not user-definable. For some distributions, therefore, different parameter variations are available. If a different combination is desired, a separate class can be created.

Please note, that Math.NET's (https://www.mathdotnet.com/) random number generator is in some situations faster. Unlike Math.NET, MultiThreadedRng is multi-threaded. Consumers can use a token to cancel e.g. timeout an operation.

FastRng (class MultiThreadedRng) using a shape fitter (a rejection sampler) to enforce arbitrary shapes of probabilities for desired distributions. By using the shape fitter, it is even easy to define discontinuous, arbitrary functions as shapes. Any consumer can define and use own distributions.

The class MultiThreadedRng uses the George Marsaglia's MWC algorithm. The algorithm's implementation based loosely on John D. Cook's (johndcook.com) implementation. Thanks John for the inspiration.

Please notice: When using the debug environment, MultiThreadedRng might uses a smaller buffer size. Please ensure, that the production environment uses a release build, though.

Usage

Example code:

using FastRng.Float;
using FastRng.Float.Distributions;

[...]

using var rng = new MultiThreadedRng<float>();
var dist = new ChiSquareK1<float>(rng);

var value1 = dist.NextNumber();
var value2 = dist.NextNumber(rangeStart: -1.0f, rangeEnd: 1.0f);
if(dist.HasDecisionBeenMade(above: 0.8f, below: 0.9f))
{
    // Decision has been made
}

Notes:

MultiThreadedRng and all distributions are using generic math types: you might use float, double, or Half.
MultiThreadedRng is IDisposable. It is important to call Dispose, when the generator is not needed anymore. Otherwise, the supporting background threads are still running.
MultiThreadedRng fills some buffers after creation. Thus, create and reuse it as long as needed. Avoid useless re-creation.
Distributions need some time at creation to calculate probabilities. Thus, just create a distribution once and use reuse it. Avoid useless re-creation.