RandomNumberStream Class

Class RandomNumberStream is a vectorized random number generator which yields a stream of random numbers from various probability distributions.

Inheritance Hierarchy

SystemObject
  CenterSpace.NMath.CoreRandomNumberStream
    CenterSpace.NMath.CoreAbstractRandomNumberStream
    CenterSpace.NMath.CoreLeapfrogStream
    CenterSpace.NMath.CoreSkipAheadStream

Namespace: CenterSpace.NMath.Core
Assembly: NMath (in NMath.dll) Version: 7.4

Syntax

C++

Copy

public class RandomNumberStream : ICloneable, 
	IDisposable

Public Class RandomNumberStream
	Implements ICloneable, IDisposable

public ref class RandomNumberStream : ICloneable, 
	IDisposable

type RandomNumberStream = 
    class
        interface ICloneable
        interface IDisposable
    end

The RandomNumberStream type exposes the following members.

Constructors

	Name	Description
	RandomNumberStream	Constructs a RandomNumberStream object of the default type with a random seed.
	RandomNumberStream(RandomNumberStreamBasicRandGenType)	Constructs a RandomNumberStream object of the specified type with a random seed.
	RandomNumberStream(Boolean)	Protected constructor for creating a RandomNumberStream object with null stream pointer.
	RandomNumberStream(Int32)	Constructs a RandomNumberStream object of the default type and given seed.
	RandomNumberStream(RandomNumberStream)	Copy constructor. Resulting object is a deep copy of the given stream.
	RandomNumberStream(Int32, RandomNumberStreamBasicRandGenType)	Constructs a RandomNumberStream object with the given seed and type.

Top

Properties

	Name	Description
	RandGenType	Gets the type.

Top

Methods

	Name	Description
	Clone	Creates a deep copy of this generator.
	Dispose	Frees the stream data structure.
	Dispose(Boolean)	Frees the stream data structure.
	FillT(IRandomNumberDistributionT, T)	Fills the given array with next random numbers from this stream.
	FillT(IRandomNumberDistributionT, T, Int32, Int32)	Fills the given array with next random numbers from this stream.
	Finalize	Frees the stream data structure. (Overrides ObjectFinalize)
	GetErrorMessage	Retrieve an error message for the given Enum value.
	LoadStreamFromFile	Sets this generators state to that stored in the given file using the SaveStreamToFile function.
	NextT	Fills a new array with next random numbers from this stream.
	Reset	Resets the the generator to the given seed.
	SaveStreamToFile	Save this generators state to a file.

Top

Fields

	Name	Description
	DEFAULT_BASIC_RNG	The default uniform generator algorithm.
	disposed_	Flag indicating if the object is disposed.
	stream_	The MKL stream pointer.
	type_	The basic random generator type.

Top

Remarks

Unlike scalar-type generators whose output is a successive random number, vector generators produce a vector of n successive random numbers from a given distribution. Vector type random number generators will generally perform better than scalar ones because overhead expense of a function call are comparable to the total time required for computation.

Reference

CenterSpace.NMath.Core Namespace