vtkMinimalStandardRandomSequence - Park and Miller Sequence of pseudo random numbers More...

Inheritance diagram for Kitware.VTK.vtkMinimalStandardRandomSequence:

Collaboration diagram for Kitware.VTK.vtkMinimalStandardRandomSequence:

Public Member Functions
	vtkMinimalStandardRandomSequence (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkMinimalStandardRandomSequence ()
	*Undocumented Block
virtual double	GetRangeValue (double rangeMin, double rangeMax)
	Convenient method to return a value in a specific range from the range [0,1. There is an initial implementation that can be overridden by a subclass. There is no pre-condition on the range:
int	GetSeed ()
	Get the seed of the random sequence. Only useful for writing correctness test.
override double	GetValue ()
	Current value.
override int	IsA (string type)
	*Undocumented Block
new vtkMinimalStandardRandomSequence	NewInstance ()
	*Undocumented Block
override void	Next ()
	Move to the next number in the random sequence.
void	SetSeed (int value)
	Set the seed of the random sequence. The following pre-condition is stated page 1197, second column: valid_seed: value>=1 && value<=2147483646 2147483646=(2^31)-2 This method does not have this criterium as a pre-condition (ie it will not fail if an incorrect seed value is passed) but the value is silently changed to fit in the valid range [1,2147483646]. 2147483646 is added to a null or negative value. 2147483647 is changed to be 1 (ie 2147483646 is substracted). Implementation note: it also performs 3 calls to Next() to avoid the bad property that the first random number is proportional to the seed value.
void	SetSeedOnly (int value)
	Set the seed of the random sequence. There is no extra internal ajustment. Only useful for writing correctness test. The following pre-condition is stated page 1197, second column 2147483646=(2^31)-2 This method does not have this criterium as a pre-condition (ie it will not fail if an incorrect seed value is passed) but the value is silently changed to fit in the valid range [1,2147483646]. 2147483646 is added to a null or negative value. 2147483647 is changed to be 1 (ie 2147483646 is substracted).
Public Member Functions inherited from Kitware.VTK.vtkRandomSequence
	vtkRandomSequence (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
Public Member Functions inherited from Kitware.VTK.vtkObject
	vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkObject ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint	AddObserver (uint arg0, vtkCommand arg1, float priority)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
uint	AddObserver (string arg0, vtkCommand arg1, float priority)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void	DebugOff ()
	Turn debugging output off.
virtual void	DebugOn ()
	Turn debugging output on.
vtkCommand	GetCommand (uint tag)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
byte	GetDebug ()
	Get the value of the debug flag.
virtual uint	GetMTime ()
	Return this object's modified time.
int	HasObserver (uint arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (string arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (uint arg0, IntPtr callData)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (string arg0, IntPtr callData)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void	Modified ()
	Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void	RemoveAllObservers ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObserver (vtkCommand arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObserver (uint tag)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (uint arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (string arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	SetDebug (byte debugFlag)
	Set the value of the debug flag. A non-zero value turns debugging on.
override string	ToString ()
	Returns the result of calling vtkObject::Print as a C# string.
delegate void	vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
	Generic signature for all vtkObject events.
void	RemoveAllHandlersForAllEvents ()
	Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
Public Member Functions inherited from Kitware.VTK.vtkObjectBase
	vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkObjectBase ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void	Register (vtkObjectBase o)
	Increase the reference count (mark as used by another object).
virtual void	FastDelete ()
	Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string	GetClassName ()
	Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int arg0)
	Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions
static new vtkMinimalStandardRandomSequence	New ()
	*Undocumented Block
static new int	IsTypeOf (string type)
	*Undocumented Block
static new vtkMinimalStandardRandomSequence	SafeDownCast (vtkObjectBase o)
	*Undocumented Block

Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkMinimalStandardRandomSequence"
	Automatically generated type registration mechanics.
Public Attributes inherited from Kitware.VTK.vtkRandomSequence
Public Attributes inherited from Kitware.VTK.vtkObject
Public Attributes inherited from Kitware.VTK.vtkObjectBase
Public Attributes inherited from Kitware.VTK.WrappedObject
const string	vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
	Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string	vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
	Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string	vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
	Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string	vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
	Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string	vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
	Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string	vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
	Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string	vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
	Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string	vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
	Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string	vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
	Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string	vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
	Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string	vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
	Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string	vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
	Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string	vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
	Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string	vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
	Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string	vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
	Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes
static new readonly string	MRClassNameKey = "32vtkMinimalStandardRandomSequence"
	Automatically generated type registration mechanics.
Static Public Attributes inherited from Kitware.VTK.vtkRandomSequence
Static Public Attributes inherited from Kitware.VTK.vtkObject
Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

Protected Member Functions
override void	Dispose (bool disposing)
	Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Static Private Member Functions
static	vtkMinimalStandardRandomSequence ()
	Automatically generated type registration mechanics.

Detailed Description

vtkMinimalStandardRandomSequence - Park and Miller Sequence of pseudo random numbers

Description vtkMinimalStandardRandomSequence is a sequence of statistically independent pseudo random numbers uniformly distributed between 0.0 and 1.0.

The sequence is generated by a prime modulus multiplicative linear congruential generator (PMMLCG) or "Lehmer generator" with multiplier 16807 and prime modulus 2^(31)-1. The authors calls it "minimal standard random number generator"

ref: "Random Number Generators: Good Ones are Hard to Find," by Stephen K. Park and Keith W. Miller in Communications of the ACM, 31, 10 (Oct. 1988) pp. 1192-1201. Code is at page 1195, "Integer version 2"

Correctness test is described in first column, page 1195: A seed of 1 at step 1 should give a seed of 1043618065 at step 10001.

Constructor & Destructor Documentation

static Kitware.VTK.vtkMinimalStandardRandomSequence.vtkMinimalStandardRandomSequence ( )

staticprivate

Automatically generated type registration mechanics.

Kitware.VTK.vtkMinimalStandardRandomSequence.vtkMinimalStandardRandomSequence	(	IntPtr	rawCppThis,
		bool	callDisposalMethod,
		bool	strong
	)

Automatically generated constructor - called from generated code. DO NOT call directly.

Kitware.VTK.vtkMinimalStandardRandomSequence.vtkMinimalStandardRandomSequence ( )

*Undocumented Block

Member Function Documentation

override void Kitware.VTK.vtkMinimalStandardRandomSequence.Dispose ( bool disposing )

protected

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkRandomSequence.

virtual double Kitware.VTK.vtkMinimalStandardRandomSequence.GetRangeValue	(	double	rangeMin,
		double	rangeMax
	)

virtual

Convenient method to return a value in a specific range from the range [0,1. There is an initial implementation that can be overridden by a subclass. There is no pre-condition on the range:

it can be in increasing order: rangeMin<rangeMax
it can be empty: rangeMin=rangeMax
it can be in decreasing order: rangeMin>rangeMax
Postcondition:
result_in_range: (rangeMin<=rangeMax && result>=rangeMin && result<=rangeMax) || (rangeMax<=rangeMin && result>=rangeMax && result<=rangeMin)

int Kitware.VTK.vtkMinimalStandardRandomSequence.GetSeed ( )

Get the seed of the random sequence. Only useful for writing correctness test.

override double Kitware.VTK.vtkMinimalStandardRandomSequence.GetValue ( )

virtual

Current value.

Postcondition:: unit_range: result>=0.0 && result<=1.0

Reimplemented from Kitware.VTK.vtkRandomSequence.

override int Kitware.VTK.vtkMinimalStandardRandomSequence.IsA ( string type )

virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkRandomSequence.

static new int Kitware.VTK.vtkMinimalStandardRandomSequence.IsTypeOf ( string type )

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkRandomSequence.

static new vtkMinimalStandardRandomSequence Kitware.VTK.vtkMinimalStandardRandomSequence.New ( )

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkObject.

new vtkMinimalStandardRandomSequence Kitware.VTK.vtkMinimalStandardRandomSequence.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkRandomSequence.

override void Kitware.VTK.vtkMinimalStandardRandomSequence.Next ( )

virtual

Move to the next number in the random sequence.

Reimplemented from Kitware.VTK.vtkRandomSequence.

static new vtkMinimalStandardRandomSequence Kitware.VTK.vtkMinimalStandardRandomSequence.SafeDownCast ( vtkObjectBase o )

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkRandomSequence.

Here is the call graph for this function:

void Kitware.VTK.vtkMinimalStandardRandomSequence.SetSeed ( int value )

Set the seed of the random sequence. The following pre-condition is stated page 1197, second column: valid_seed: value>=1 && value<=2147483646 2147483646=(2^31)-2 This method does not have this criterium as a pre-condition (ie it will not fail if an incorrect seed value is passed) but the value is silently changed to fit in the valid range [1,2147483646]. 2147483646 is added to a null or negative value. 2147483647 is changed to be 1 (ie 2147483646 is substracted). Implementation note: it also performs 3 calls to Next() to avoid the bad property that the first random number is proportional to the seed value.

void Kitware.VTK.vtkMinimalStandardRandomSequence.SetSeedOnly ( int value )

Set the seed of the random sequence. There is no extra internal ajustment. Only useful for writing correctness test. The following pre-condition is stated page 1197, second column 2147483646=(2^31)-2 This method does not have this criterium as a pre-condition (ie it will not fail if an incorrect seed value is passed) but the value is silently changed to fit in the valid range [1,2147483646]. 2147483646 is added to a null or negative value. 2147483647 is changed to be 1 (ie 2147483646 is substracted).