Click or drag to resize

ALFGenerator Class

Represents a Additive Lagged Fibonacci pseudo-random number generator.
Inheritance Hierarchy
SystemObject
  Altaxo.Calc.ProbabilityGenerator
    Altaxo.Calc.ProbabilityALFGenerator

Namespace: Altaxo.Calc.Probability
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
public class ALFGenerator : Generator

The ALFGenerator type exposes the following members.

Constructors
 NameDescription
Public methodALFGenerator Initializes a new instance of the ALFGenerator class, using a time-dependent default seed value.
Public methodALFGenerator(Int32) Initializes a new instance of the ALFGenerator class, using the specified seed value.
Public methodALFGenerator(UInt32) Initializes a new instance of the StandardGenerator class, using the specified seed value.
Top
Properties
 NameDescription
Public propertyCanReset Gets a value indicating whether the ALFGenerator can be reset, so that it produces the same pseudo-random number sequence again.
(Overrides GeneratorCanReset)
Public propertyLongLag Gets or sets the long lag of the Lagged Fibonacci pseudo-random number generator.
Public propertyMaximum Gets the maximum number that a call to Next can return.
(Inherited from Generator)
Public propertyShortLag Gets or sets the short lag of the Lagged Fibonacci pseudo-random number generator.
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIsValidLongLag Determines whether the specified value is valid for parameter LongLag.
Public methodIsValidShortLag Determines whether the specified value is valid for parameter ShortLag.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodNext Returns a nonnegative random number less than MaxValue.
(Overrides GeneratorNext)
Public methodNext(Int32) Returns a nonnegative random number less than the specified maximum.
(Overrides GeneratorNext(Int32))
Public methodNext(Int32, Int32) Returns a random number within the specified range.
(Overrides GeneratorNext(Int32, Int32))
Public methodNextBoolean Returns a random Boolean value.
(Overrides GeneratorNextBoolean)
Public methodNextBytes Fills the elements of a specified array of bytes with random numbers.
(Overrides GeneratorNextBytes(Byte))
Public methodNextDouble Returns a nonnegative floating point random number less than 1.0.
(Overrides GeneratorNextDouble)
Public methodNextDouble(Double) Returns a nonnegative floating point random number less than the specified maximum.
(Overrides GeneratorNextDouble(Double))
Public methodNextDouble(Double, Double) Returns a floating point random number within the specified range.
(Overrides GeneratorNextDouble(Double, Double))
Public methodNextInclusiveMaxValue Returns a nonnegative random number less than or equal to MaxValue.
Public methodNextPositiveDouble 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)
Public methodNextUInt Returns an unsigned random number.
Public methodReset Resets the ALFGenerator, so that it produces the same pseudo-random number sequence again.
(Overrides GeneratorReset)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
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