VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkMersenneTwister Class Reference

Generator for Mersenne Twister pseudorandom numbers. More...

#include <vtkMersenneTwister.h>

Inheritance diagram for vtkMersenneTwister:
[legend]
Collaboration diagram for vtkMersenneTwister:
[legend]

Public Types

typedef vtkTypeUInt32 SequenceId
 
typedef vtkRandomSequence Superclass
 
- Public Types inherited from vtkRandomSequence
typedef vtkObject Superclass
 Standard methods for type information and printing. More...
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkMersenneTwisterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Initialize (vtkTypeUInt32 seed) override
 Satisfy general API of vtkRandomSequence superclass. More...
 
SequenceId InitializeNewSequence (vtkTypeUInt32 seed, int p=521)
 Initialize a new Mersenne Twister sequence, given a) a <seed> and b) a Mersenne exponent (p s.t. More...
 
void InitializeSequence (SequenceId id, vtkTypeUInt32 seed, int p=521)
 Initialize a sequence as in InitializeNewSequence(), but additionally pass an id to associate with the new sequence. More...
 
virtual double GetValue (SequenceId id)
 Current value. More...
 
double GetValue () override
 Current value. More...
 
virtual void Next (SequenceId id)
 Move to the next number in random sequence <id>. More...
 
void Next () override
 Move to the next number in random sequence <0>. More...
 
- Public Member Functions inherited from vtkRandomSequence
vtkRandomSequenceNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkMersenneTwisterNew ()
 Standard methods for instantiation, type information, and printing. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkMersenneTwisterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkRandomSequence
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRandomSequenceSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkMersenneTwister ()
 
 ~vtkMersenneTwister () override
 
- Protected Member Functions inherited from vtkRandomSequence
 vtkRandomSequence ()
 
 ~vtkRandomSequence () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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

vtkMersenneTwisterInternals * Internal
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Generator for Mersenne Twister pseudorandom numbers.

vtkMersenneTwister is an implementation of the Mersenne Twister pseudorandom number generator. The VTK class is simply a wrapper around an implementation written by M. Matsumoto, T. Nishimura and M. Saito, whose source code can be found at http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/DC/dc.html.

This implementation of the Mersenne Twister facilitates the generation and query from multiple independent pseudorandom sequences. Independent sequences are identified by a unique vtkMersenneTwister::SequenceId, which is either generated upon request or passed into the initialization method. This id is factored into the initialization of the Mersenne Twister's initial state, so two sequences with the same seed and different sequence ids will produce different results. Once a sequence is initialized with an associated sequence id, this id is used to obtain values from the sequence.

This class, besides generating random sequences in sequential order, can also populate a double array of specified size with a random sequence. It will do so using one or more threads depending on the number of values requested to generate.

Warning
This class has been threaded with vtkMultiThreader. The amount of work each thread performs is controlled by the #define VTK_MERSENNE_CHUNK.

Definition at line 80 of file vtkMersenneTwister.h.

Member Typedef Documentation

◆ SequenceId

typedef vtkTypeUInt32 vtkMersenneTwister::SequenceId

Definition at line 83 of file vtkMersenneTwister.h.

◆ Superclass

Definition at line 90 of file vtkMersenneTwister.h.

Constructor & Destructor Documentation

◆ vtkMersenneTwister()

vtkMersenneTwister::vtkMersenneTwister ( )
protected

◆ ~vtkMersenneTwister()

vtkMersenneTwister::~vtkMersenneTwister ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkMersenneTwister* vtkMersenneTwister::New ( )
static

Standard methods for instantiation, type information, and printing.

◆ IsTypeOf()

static vtkTypeBool vtkMersenneTwister::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkMersenneTwister::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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkMersenneTwister::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkRandomSequence.

◆ NewInstance()

vtkMersenneTwister* vtkMersenneTwister::NewInstance ( ) const

◆ PrintSelf()

void vtkMersenneTwister::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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

◆ Initialize()

void vtkMersenneTwister::Initialize ( vtkTypeUInt32  seed)
inlineoverridevirtual

Satisfy general API of vtkRandomSequence superclass.

Initialize the sequence with a seed.

Implements vtkRandomSequence.

Definition at line 98 of file vtkMersenneTwister.h.

◆ InitializeNewSequence()

SequenceId vtkMersenneTwister::InitializeNewSequence ( vtkTypeUInt32  seed,
int  p = 521 
)

Initialize a new Mersenne Twister sequence, given a) a <seed> and b) a Mersenne exponent (p s.t.

2^p-1 is a Mersenne prime). If

is not a usable Mersenne exponent, its value is used to pick one from a list. The return value is the id for the generated sequence, which is used as a key to access values of the sequence.

◆ InitializeSequence()

void vtkMersenneTwister::InitializeSequence ( SequenceId  id,
vtkTypeUInt32  seed,
int  p = 521 
)

Initialize a sequence as in InitializeNewSequence(), but additionally pass an id to associate with the new sequence.

If a sequence is already associated with this id, a warning is given and the sequence is reset using the given parameters.

◆ GetValue() [1/2]

virtual double vtkMersenneTwister::GetValue ( SequenceId  id)
virtual

Current value.

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

◆ GetValue() [2/2]

double vtkMersenneTwister::GetValue ( )
inlineoverridevirtual

Current value.

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

Implements vtkRandomSequence.

Definition at line 127 of file vtkMersenneTwister.h.

◆ Next() [1/2]

virtual void vtkMersenneTwister::Next ( SequenceId  id)
virtual

Move to the next number in random sequence <id>.

If no sequence is associated with this id, a warning is given and a sequence is generated with default values.

◆ Next() [2/2]

void vtkMersenneTwister::Next ( )
inlineoverridevirtual

Move to the next number in random sequence <0>.

If no sequence is associated with this id, a warning is given and a sequence is generated with default values.

Implements vtkRandomSequence.

Definition at line 141 of file vtkMersenneTwister.h.

Member Data Documentation

◆ Internal

vtkMersenneTwisterInternals* vtkMersenneTwister::Internal
protected

Definition at line 147 of file vtkMersenneTwister.h.


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