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

#include <vtkMinimalStandardRandomSequence.h>

Inheritance diagram for vtkMinimalStandardRandomSequence:

Collaboration diagram for vtkMinimalStandardRandomSequence:

Public Types
typedef vtkRandomSequence	Superclass

Public Types inherited from vtkRandomSequence
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkMinimalStandardRandomSequence *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	SetSeed (int value)

void	SetSeedOnly (int value)

int	GetSeed ()

virtual double	GetValue ()

virtual void	Next ()


virtual double	GetRangeValue (double rangeMin, double rangeMax)

Public Member Functions inherited from vtkRandomSequence
vtkRandomSequence *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkMinimalStandardRandomSequence *	SafeDownCast (vtkObjectBase *o)

static vtkMinimalStandardRandomSequence *	New ()

Static Public Member Functions inherited from vtkRandomSequence
static int	IsTypeOf (const char *type)

static vtkRandomSequence *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkMinimalStandardRandomSequence ()

virtual	~vtkMinimalStandardRandomSequence ()

Protected Member Functions inherited from vtkRandomSequence
	vtkRandomSequence ()

virtual	~vtkRandomSequence ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	Seed

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Park and Miller Sequence of pseudo random numbers.

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.

Examples:: vtkMinimalStandardRandomSequence (Examples)

Tests:: vtkMinimalStandardRandomSequence (Tests)

Definition at line 46 of file vtkMinimalStandardRandomSequence.h.

Member Typedef Documentation

typedef vtkRandomSequence vtkMinimalStandardRandomSequence::Superclass

Definition at line 50 of file vtkMinimalStandardRandomSequence.h.

Constructor & Destructor Documentation

vtkMinimalStandardRandomSequence::vtkMinimalStandardRandomSequence ( )

protected

virtual vtkMinimalStandardRandomSequence::~vtkMinimalStandardRandomSequence ( )

protectedvirtual

Member Function Documentation

static int vtkMinimalStandardRandomSequence::IsTypeOf ( const char * type )

static

virtual int vtkMinimalStandardRandomSequence::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkRandomSequence.

static vtkMinimalStandardRandomSequence* vtkMinimalStandardRandomSequence::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkMinimalStandardRandomSequence::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkRandomSequence.

vtkMinimalStandardRandomSequence* vtkMinimalStandardRandomSequence::NewInstance ( ) const

void vtkMinimalStandardRandomSequence::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

static vtkMinimalStandardRandomSequence* vtkMinimalStandardRandomSequence::New ( )

static

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

int vtkMinimalStandardRandomSequence::GetSeed ( )

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

virtual double vtkMinimalStandardRandomSequence::GetValue ( )

virtual

Current value

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

Implements vtkRandomSequence.

virtual void vtkMinimalStandardRandomSequence::Next ( )

virtual

Move to the next number in the random sequence.

Implements vtkRandomSequence.

virtual double 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)

Member Data Documentation

int vtkMinimalStandardRandomSequence::Seed

protected

Definition at line 103 of file vtkMinimalStandardRandomSequence.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/Core/vtkMinimalStandardRandomSequence.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation