VTK
|
Generator for Mersenne Twister pseudorandom numbers. More...
#include <vtkMersenneTwister.h>
Public Types | |
typedef vtkTypeUInt32 | SequenceId |
typedef vtkRandomSequence | Superclass |
![]() | |
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... | |
vtkMersenneTwister * | NewInstance () 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... | |
![]() | |
vtkRandomSequence * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
![]() | |
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) |
vtkCommand * | GetCommand (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) |
![]() | |
const char * | GetClassName () const |
Return the class name as a string. 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 vtkMersenneTwister * | New () |
Standard methods for instantiation, type information, and printing. More... | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkMersenneTwister * | SafeDownCast (vtkObjectBase *o) |
![]() | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkRandomSequence * | SafeDownCast (vtkObjectBase *o) |
![]() | |
static vtkObject * | New () |
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 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 vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkMersenneTwister () | |
~vtkMersenneTwister () override | |
![]() | |
vtkRandomSequence () | |
~vtkRandomSequence () override | |
![]() | |
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 () |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | CollectRevisions (ostream &) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkMersenneTwisterInternals * | Internal |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
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.
Definition at line 80 of file vtkMersenneTwister.h.
typedef vtkTypeUInt32 vtkMersenneTwister::SequenceId |
Definition at line 83 of file vtkMersenneTwister.h.
Definition at line 90 of file vtkMersenneTwister.h.
|
protected |
|
overrideprotected |
|
static |
Standard methods for instantiation, type information, and printing.
|
static |
|
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 |
|
protectedvirtual |
Reimplemented from vtkRandomSequence.
vtkMersenneTwister* vtkMersenneTwister::NewInstance | ( | ) | const |
|
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.
|
inlineoverridevirtual |
Satisfy general API of vtkRandomSequence superclass.
Initialize the sequence with a seed.
Implements vtkRandomSequence.
Definition at line 98 of file vtkMersenneTwister.h.
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.
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.
|
virtual |
Current value.
|
inlineoverridevirtual |
Current value.
Implements vtkRandomSequence.
Definition at line 128 of file vtkMersenneTwister.h.
|
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.
|
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 142 of file vtkMersenneTwister.h.
|
protected |
Definition at line 148 of file vtkMersenneTwister.h.