Generate a sequence of random numbers. More...

#include <vtkRandomSequence.h>

Inheritance diagram for vtkRandomSequence:

Collaboration diagram for vtkRandomSequence:

Public Member Functions
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.

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

typedef vtkObject	Superclass
	Standard methods for type information and printing.

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.

virtual vtkTypeBool	IsA (const char *type)
	Standard methods for type information and printing.

vtkRandomSequence *	NewInstance () const
	Standard methods for type information and printing.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for type information and printing.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for type information and printing.

Additional Inherited Members
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 ()

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

Generate a sequence of random numbers.

vtkRandomSequence defines the interface of any sequence of random numbers.

At this level of abstraction, there is no assumption about the distribution of the numbers or about the quality of the sequence of numbers to be statistically independent. There is no assumption about the range of values.

To the question about why a random "sequence" class instead of a random "generator" class or to a random "number" class?, see the OOSC book: "Object-Oriented Software Construction", 2nd Edition, by Bertrand Meyer. chapter 23, "Principles of class design", "Pseudo-random number generators: a design exercise", page 754–755.

Definition at line 37 of file vtkRandomSequence.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkRandomSequence::Superclass

Standard methods for type information and printing.

Definition at line 44 of file vtkRandomSequence.h.

Constructor & Destructor Documentation

◆ vtkRandomSequence()

vtkRandomSequence::vtkRandomSequence ( )

protected

◆ ~vtkRandomSequence()

vtkRandomSequence::~vtkRandomSequence ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

Standard methods for type information and printing.

◆ IsA()

virtual vtkTypeBool vtkRandomSequence::IsA ( const char * type )

virtual

Standard methods for type information and printing.

Reimplemented from vtkObjectBase.

Reimplemented in vtkBoxMuellerRandomSequence, vtkGaussianRandomSequence, vtkMersenneTwister, and vtkMinimalStandardRandomSequence.

◆ SafeDownCast()

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

static

Standard methods for type information and printing.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkRandomSequence::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for type information and printing.

Reimplemented in vtkBoxMuellerRandomSequence, vtkGaussianRandomSequence, vtkMersenneTwister, and vtkMinimalStandardRandomSequence.

◆ NewInstance()

vtkRandomSequence * vtkRandomSequence::NewInstance ( ) const

Standard methods for type information and printing.

◆ PrintSelf()

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

overridevirtual

Standard methods for type information and printing.

Reimplemented from vtkObject.

◆ Initialize()

virtual void vtkRandomSequence::Initialize ( vtkTypeUInt32 seed )

pure virtual

Initialize the sequence with a seed.

Implemented in vtkMersenneTwister, and vtkMinimalStandardRandomSequence.

◆ GetValue()

virtual double vtkRandomSequence::GetValue ( )

pure virtual

Return the current value.

Implemented in vtkBoxMuellerRandomSequence, vtkMersenneTwister, and vtkMinimalStandardRandomSequence.

◆ Next()

virtual void vtkRandomSequence::Next ( )

pure virtual

Move to the next number in the random sequence.

Implemented in vtkBoxMuellerRandomSequence, vtkMersenneTwister, and vtkMinimalStandardRandomSequence.

◆ GetNextValue()

double vtkRandomSequence::GetNextValue ( )

Advance the sequence and return the new value.

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

Common/Core/vtkRandomSequence.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkRandomSequence()

◆ ~vtkRandomSequence()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ Initialize()

◆ GetValue()

◆ Next()

◆ GetNextValue()