ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkMinimalStandardRandomSequence Class Reference

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

Inheritance diagram for Kitware.VTK.vtkMinimalStandardRandomSequence:
[legend]
Collaboration diagram for Kitware.VTK.vtkMinimalStandardRandomSequence:
[legend]

List of all members.

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).

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.

Static Public Attributes

static new readonly string MRClassNameKey = "32vtkMinimalStandardRandomSequence"
 Automatically generated type registration mechanics.

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.

Private Member Functions

static internal IntPtr vtkMinimalStandardRandomSequence_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal double vtkMinimalStandardRandomSequence_GetRangeValue_01 (HandleRef pThis, double rangeMin, double rangeMax)
static internal int vtkMinimalStandardRandomSequence_GetSeed_02 (HandleRef pThis)
static internal double vtkMinimalStandardRandomSequence_GetValue_03 (HandleRef pThis)
static internal int vtkMinimalStandardRandomSequence_IsA_04 (HandleRef pThis, string type)
static internal int vtkMinimalStandardRandomSequence_IsTypeOf_05 (string type)
static internal IntPtr vtkMinimalStandardRandomSequence_NewInstance_07 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkMinimalStandardRandomSequence_Next_08 (HandleRef pThis)
static internal IntPtr vtkMinimalStandardRandomSequence_SafeDownCast_09 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkMinimalStandardRandomSequence_SetSeed_10 (HandleRef pThis, int value)
static internal void vtkMinimalStandardRandomSequence_SetSeedOnly_11 (HandleRef pThis, int value)

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

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.

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)

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

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.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkRandomSequence.

Move to the next number in the random sequence.

Reimplemented from Kitware.VTK.vtkRandomSequence.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkRandomSequence.

Here is the call graph for this function:

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.

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).

static internal double Kitware.VTK.vtkMinimalStandardRandomSequence.vtkMinimalStandardRandomSequence_GetRangeValue_01 ( HandleRef  pThis,
double  rangeMin,
double  rangeMax 
) [private]
static internal int Kitware.VTK.vtkMinimalStandardRandomSequence.vtkMinimalStandardRandomSequence_IsA_04 ( HandleRef  pThis,
string  type 
) [private]
static internal IntPtr Kitware.VTK.vtkMinimalStandardRandomSequence.vtkMinimalStandardRandomSequence_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkMinimalStandardRandomSequence.vtkMinimalStandardRandomSequence_NewInstance_07 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkMinimalStandardRandomSequence.vtkMinimalStandardRandomSequence_SafeDownCast_09 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkMinimalStandardRandomSequence.vtkMinimalStandardRandomSequence_SetSeed_10 ( HandleRef  pThis,
int  value 
) [private]
static internal void Kitware.VTK.vtkMinimalStandardRandomSequence.vtkMinimalStandardRandomSequence_SetSeedOnly_11 ( HandleRef  pThis,
int  value 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkMinimalStandardRandomSequence.MRClassNameKey = "32vtkMinimalStandardRandomSequence" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkRandomSequence.

new const string Kitware.VTK.vtkMinimalStandardRandomSequence.MRFullTypeName = "Kitware.VTK.vtkMinimalStandardRandomSequence"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkRandomSequence.


The documentation for this class was generated from the following file: