VTK
9.1.0
|
Generator for Mersenne Twister pseudorandom numbers. More...
#include <vtkMersenneTwister.h>
Public Types | |
typedef vtkTypeUInt32 | SequenceId |
Public Types inherited from vtkRandomSequence | |
typedef vtkObject | Superclass |
Standard methods for type information and printing. | |
Public Member Functions | |
void | Initialize (vtkTypeUInt32 seed) override |
Satisfy general API of vtkRandomSequence superclass. | |
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. | |
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. | |
virtual double | GetValue (SequenceId id) |
Current value. | |
double | GetValue () override |
Current value. | |
virtual void | Next (SequenceId id) |
Move to the next number in random sequence id . | |
void | Next () override |
Move to the next number in random sequence <0>. | |
Public Member Functions inherited from vtkRandomSequence | |
virtual void | Initialize (vtkTypeUInt32 seed)=0 |
Initialize the sequence with a seed. | |
virtual double | GetValue ()=0 |
Return the current value. | |
virtual void | Next ()=0 |
Move to the next number in the random sequence. | |
double | GetNextValue () |
Advance the sequence and return the new value. | |
vtkRandomSequence * | NewInstance () const |
Standard methods for type information and printing. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Standard methods for type information and printing. | |
Public Member Functions inherited from vtkObject | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. | |
virtual void | DebugOff () |
Turn debugging output off. | |
bool | GetDebug () |
Get the value of the debug flag. | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. | |
virtual void | Modified () |
Update the modification time for this object. | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
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) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
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. | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. | |
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. | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
int | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
Given 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). | |
virtual void | Delete () |
Delete a VTK object. | |
virtual void | FastDelete () |
Delete a reference to this object. | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. | |
virtual void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). | |
int | GetReferenceCount () |
Return the current reference count of this object. | |
void | SetReferenceCount (int) |
Sets the reference count. | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
Protected Member Functions | |
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. | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. | |
Protected Member Functions inherited from vtkObjectBase | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
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 |
typedef vtkRandomSequence | Superclass |
Standard methods for instantiation, type information, and printing. | |
static vtkMersenneTwister * | New () |
Standard methods for instantiation, type information, and printing. | |
static vtkTypeBool | IsTypeOf (const char *type) |
Standard methods for instantiation, type information, and printing. | |
static vtkMersenneTwister * | SafeDownCast (vtkObjectBase *o) |
Standard methods for instantiation, type information, and printing. | |
virtual vtkTypeBool | IsA (const char *type) |
Standard methods for instantiation, type information, and printing. | |
vtkMersenneTwister * | NewInstance () const |
Standard methods for instantiation, type information, and printing. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Standard methods for instantiation, type information, and printing. | |
virtual vtkObjectBase * | NewInstanceInternal () const |
Standard methods for instantiation, type information, and printing. | |
Additional Inherited Members | |
Static Public Member Functions inherited from vtkRandomSequence | |
static vtkTypeBool | IsTypeOf (const char *type) |
Standard methods for type information and printing. | |
static vtkRandomSequence * | SafeDownCast (vtkObjectBase *o) |
Standard methods for type information and printing. | |
Static Public Member Functions inherited from vtkObject | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. | |
static void | SetGlobalWarningDisplay (int val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static int | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
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. | |
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). | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. | |
static bool | GetUsingMemkind () |
A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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 76 of file vtkMersenneTwister.h.
typedef vtkTypeUInt32 vtkMersenneTwister::SequenceId |
Definition at line 79 of file vtkMersenneTwister.h.
Standard methods for instantiation, type information, and printing.
Definition at line 86 of file vtkMersenneTwister.h.
|
protected |
|
overrideprotected |
|
static |
Standard methods for instantiation, type information, and printing.
|
static |
Standard methods for instantiation, type information, and printing.
|
virtual |
Standard methods for instantiation, type information, and printing.
Reimplemented from vtkRandomSequence.
|
static |
Standard methods for instantiation, type information, and printing.
|
protectedvirtual |
Standard methods for instantiation, type information, and printing.
Reimplemented from vtkRandomSequence.
vtkMersenneTwister * vtkMersenneTwister::NewInstance | ( | ) | const |
Standard methods for instantiation, type information, and printing.
|
overridevirtual |
Standard methods for instantiation, type information, and printing.
Reimplemented from vtkObjectBase.
|
inlineoverridevirtual |
Satisfy general API of vtkRandomSequence superclass.
Initialize the sequence with a seed.
Implements vtkRandomSequence.
Definition at line 94 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 p
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 123 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 137 of file vtkMersenneTwister.h.
|
protected |
Definition at line 143 of file vtkMersenneTwister.h.