ALFGenerator Class |
Represents a Additive Lagged Fibonacci pseudo-random number generator.
Inheritance HierarchyNamespace: Altaxo.Calc.Probability
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3261.0 (4.8.3261.0)
SyntaxC#
public class ALFGenerator : Generator
The ALFGenerator type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ALFGenerator | Initializes a new instance of the ALFGenerator class, using a time-dependent default seed value. |
| ALFGenerator(Int32) | Initializes a new instance of the ALFGenerator class, using the specified seed value. |
| ALFGenerator(UInt32) | Initializes a new instance of the StandardGenerator class, using the specified seed value. |
Properties| Name | Description | |
|---|---|---|
 | CanReset |
Gets a value indicating whether the ALFGenerator can be reset, so that it produces the
same pseudo-random number sequence again.
(Overrides GeneratorCanReset) |
| LongLag | Gets or sets the long lag of the Lagged Fibonacci pseudo-random number generator. |
| Maximum |
Gets the maximum number that a call to Next can return.
(Inherited from Generator) |
| ShortLag | Gets or sets the short lag of the Lagged Fibonacci pseudo-random number generator. |
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| IsValidLongLag | Determines whether the specified value is valid for parameter LongLag. |
| IsValidShortLag | Determines whether the specified value is valid for parameter ShortLag. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Next |
Returns a nonnegative random number less than MaxValue.
(Overrides GeneratorNext) |
| Next(Int32) |
Returns a nonnegative random number less than the specified maximum.
(Overrides GeneratorNext(Int32)) |
| Next(Int32, Int32) |
Returns a random number within the specified range.
(Overrides GeneratorNext(Int32, Int32)) |
| NextBoolean |
Returns a random Boolean value.
(Overrides GeneratorNextBoolean) |
| NextBytes |
Fills the elements of a specified array of bytes with random numbers.
(Overrides GeneratorNextBytes(Byte)) |
| NextDouble |
Returns a nonnegative floating point random number less than 1.0.
(Overrides GeneratorNextDouble) |
| NextDouble(Double) |
Returns a nonnegative floating point random number less than the specified maximum.
(Overrides GeneratorNextDouble(Double)) |
| NextDouble(Double, Double) |
Returns a floating point random number within the specified range.
(Overrides GeneratorNextDouble(Double, Double)) |
| NextInclusiveMaxValue | Returns a nonnegative random number less than or equal to MaxValue. |
| NextPositiveDouble |
Returns a floating point random number in the range (0,1), i.e. greater than 0.0 and less than 1.0.
(Inherited from Generator) |
| NextUInt | Returns an unsigned random number. |
| Reset |
Resets the ALFGenerator, so that it produces the same pseudo-random number sequence again.
(Overrides GeneratorReset) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Remarks
The ALFGenerator type bases upon the implementation in the
Boost Random Number Library.
It uses the modulus 232 and by default the "lags" 418 and 1279, which can be adjusted through the
associated ShortLag and LongLag properties. Some popular pairs are presented on
Wikipedia - Lagged Fibonacci generator.
See Also