ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
itk::Statistics::MersenneTwisterRandomVariateGenerator Class Reference

#include <itkMersenneTwisterRandomVariateGenerator.h>

+ Inheritance diagram for itk::Statistics::MersenneTwisterRandomVariateGenerator:
+ Collaboration diagram for itk::Statistics::MersenneTwisterRandomVariateGenerator:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using IntegerType = uint32_t
 
using Pointer = SmartPointer< Self >
 
using Self = MersenneTwisterRandomVariateGenerator
 
using Superclass = RandomVariateGeneratorBase
 
- Public Types inherited from itk::Statistics::RandomVariateGeneratorBase
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = RandomVariateGeneratorBase
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual const char * GetNameOfClass () const
 
void Initialize ()
 
void Initialize (const IntegerType oneSeed)
 
double GetVariateWithClosedRange ()
 
double GetVariateWithClosedRange (const double &n)
 
double GetVariateWithOpenUpperRange ()
 
double GetVariateWithOpenUpperRange (const double &n)
 
double GetVariateWithOpenRange ()
 
double GetVariateWithOpenRange (const double &n)
 
IntegerType GetIntegerVariate ()
 
IntegerType GetIntegerVariate (const IntegerType &n)
 
double Get53BitVariate ()
 
double GetNormalVariate (const double &mean=0.0, const double &variance=1.0)
 
double GetUniformVariate (const double &a, const double &b)
 
double GetVariate () override
 
double operator() ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer GetInstance ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr IntegerType StateVectorLength = 624
 
static constexpr unsigned int M = 397
 
IntegerType state [StateVectorLength]
 
IntegerTypem_PNext
 
int m_Left
 
std::atomic< IntegerTypem_Seed
 
std::mutex m_InstanceLock
 
static MersenneTwisterGlobals * m_PimplGlobals
 
void SetSeed (const IntegerType oneSeed)
 
void SetSeed ()
 
IntegerType GetSeed () const
 
static IntegerType GetNextSeed ()
 
 MersenneTwisterRandomVariateGenerator ()
 
 ~MersenneTwisterRandomVariateGenerator () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void reload ()
 
IntegerType hiBit (const IntegerType &u) const
 
IntegerType loBit (const IntegerType &u) const
 
IntegerType loBits (const IntegerType &u) const
 
IntegerType mixBits (const IntegerType &u, const IntegerType &v) const
 
IntegerType twist (const IntegerType &m, const IntegerType &s0, const IntegerType &s1) const
 
static IntegerType hash (time_t t, clock_t c)
 
 itkGetGlobalDeclarationMacro (MersenneTwisterGlobals, PimplGlobals)
 
static Pointer CreateInstance ()
 

Additional Inherited Members

- Protected Member Functions inherited from itk::Statistics::RandomVariateGeneratorBase
 RandomVariateGeneratorBase ()
 
 ~RandomVariateGeneratorBase () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

MersenneTwisterRandom random variate generator.

It is recommended to create a separate object in each thread. By default, each instantiated class will have a different seed created by the GetNextSeed method. The creation of the initial seeds are initialized once from the time. For deterministic behavior, the individual instances' seeds should be manual set to separate values in each thread.

It is no longer recommended to use this class using a "Singleton-like" GetInstance method for the global instance of this class. This usage may result in unsafe concurrent access to the global instance.

Warning
This class's instance methods are NEITHER reentrant nor concurrent thread-safe, except where marked as thread-safe. That is to say you can still use separate objects concurrently.

This notice was included with the original implementation. The only changes made were to obfuscate the author's email addresses.

MersenneTwister.h Mersenne Twister random number generator – a C++ class MTRand Based on code by Makoto Matsumoto, Takuji Nishimura, and Shawn Cokus Richard J. Wagner v1.0 15 May 2003 rjwagner at writeme dot com

The Mersenne Twister is an algorithm for generating random numbers. It was designed with consideration of the flaws in various other generators. The period, 2^19937-1, and the order of equidistribution, 623 dimensions, are far greater. The generator is also fast; it avoids multiplication and division, and it benefits from caches and pipelines. For more information see the inventors' web page at http:*www.math.keio.ac.jp/~matumoto/emt.html

Reference M. Matsumoto and T. Nishimura, "Mersenne Twister: A 623-Dimensionally Equidistributed Uniform Pseudo-Random Number Generator", ACM Transactions on Modeling and Computer Simulation, Vol. 8, No. 1, January 1998, pp 3-30.

Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura, Copyright (C) 2000 - 2003, Richard J. Wagner All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. The names of its contributors may not be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The original code included the following notice:

When you use this, send an email to: matumoto at math dot keio dot ac dot jp
with an appropriate reference to your work.

It would be nice to CC: rjwagner at writeme dot com and Cokus at math dot washington dot edu when you write.

ITK Sphinx Examples:
Examples
SphinxExamples/src/Core/Common/AddNoiseToBinaryImage/Code.cxx, SphinxExamples/src/Core/Common/MersenneTwisterRandomIntegerGenerator/Code.cxx, and SphinxExamples/src/Core/Common/MersenneTwisterRandomNumberGenerator/Code.cxx.

Definition at line 127 of file itkMersenneTwisterRandomVariateGenerator.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 134 of file itkMersenneTwisterRandomVariateGenerator.h.

◆ IntegerType

Definition at line 136 of file itkMersenneTwisterRandomVariateGenerator.h.

◆ Pointer

Definition at line 133 of file itkMersenneTwisterRandomVariateGenerator.h.

◆ Self

Standard class type aliases.

Definition at line 131 of file itkMersenneTwisterRandomVariateGenerator.h.

◆ Superclass

Definition at line 132 of file itkMersenneTwisterRandomVariateGenerator.h.

Constructor & Destructor Documentation

◆ MersenneTwisterRandomVariateGenerator()

itk::Statistics::MersenneTwisterRandomVariateGenerator::MersenneTwisterRandomVariateGenerator ( )
protected

Period parameter

◆ ~MersenneTwisterRandomVariateGenerator()

itk::Statistics::MersenneTwisterRandomVariateGenerator::~MersenneTwisterRandomVariateGenerator ( )
overrideprotected

Period parameter

Member Function Documentation

◆ CreateInstance()

static Pointer itk::Statistics::MersenneTwisterRandomVariateGenerator::CreateInstance ( )
staticprivate

Internal method to actually create a new object.

◆ Get53BitVariate()

double itk::Statistics::MersenneTwisterRandomVariateGenerator::Get53BitVariate ( )
inline

Access to 53-bit random numbers (capacity of IEEE double precision) in the range [0,1)

Definition at line 498 of file itkMersenneTwisterRandomVariateGenerator.h.

References GetIntegerVariate().

◆ GetInstance()

static Pointer itk::Statistics::MersenneTwisterRandomVariateGenerator::GetInstance ( )
static

Return the global Mersenne Twister instance.

This method returns a Singleton of the Mersenne Twister. The seed is initialized from the wall clock at first use, but can be globally set using the resulting instance's SetSeed().

Note
This method is thread-safe.
Examples
Examples/RegistrationITKv4/DeformableRegistration13.cxx.

◆ GetIntegerVariate() [1/2]

MersenneTwisterRandomVariateGenerator::IntegerType itk::Statistics::MersenneTwisterRandomVariateGenerator::GetIntegerVariate ( )
inline

◆ GetIntegerVariate() [2/2]

MersenneTwisterRandomVariateGenerator::IntegerType itk::Statistics::MersenneTwisterRandomVariateGenerator::GetIntegerVariate ( const IntegerType n)
inline

Get an integer variate in [0, n] for n < 2^32

Definition at line 474 of file itkMersenneTwisterRandomVariateGenerator.h.

References GetIntegerVariate().

◆ GetNameOfClass()

virtual const char* itk::Statistics::MersenneTwisterRandomVariateGenerator::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Statistics::RandomVariateGeneratorBase.

◆ GetNextSeed()

static IntegerType itk::Statistics::MersenneTwisterRandomVariateGenerator::GetNextSeed ( )
static

Return the next seed, derived as a sequence from the seed of the singleton instance.

Note
This method is thread-safe.

◆ GetNormalVariate()

double itk::Statistics::MersenneTwisterRandomVariateGenerator::GetNormalVariate ( const double &  mean = 0.0,
const double &  variance = 1.0 
)
inline

Access to a normal random number distribution.

Definition at line 509 of file itkMersenneTwisterRandomVariateGenerator.h.

References GetVariateWithOpenRange(), GetVariateWithOpenUpperRange(), and itk::Math::pi.

◆ GetSeed()

MersenneTwisterRandomVariateGenerator::IntegerType itk::Statistics::MersenneTwisterRandomVariateGenerator::GetSeed ( ) const
inline

Return the current seed

Note
This method is thread-safe.

Definition at line 409 of file itkMersenneTwisterRandomVariateGenerator.h.

References m_Seed.

◆ GetUniformVariate()

double itk::Statistics::MersenneTwisterRandomVariateGenerator::GetUniformVariate ( const double &  a,
const double &  b 
)
inline

Access to a uniform random number distribution

Definition at line 523 of file itkMersenneTwisterRandomVariateGenerator.h.

References GetVariateWithOpenUpperRange().

◆ GetVariate()

double itk::Statistics::MersenneTwisterRandomVariateGenerator::GetVariate ( )
inlineoverridevirtual

Get a variate in the range [0, 1] Do NOT use for CRYPTOGRAPHY without securely hashing several returned values together, otherwise the generator state can be learned after reading 624 consecutive values.

Implements itk::Statistics::RandomVariateGeneratorBase.

Definition at line 531 of file itkMersenneTwisterRandomVariateGenerator.h.

References GetVariateWithClosedRange().

Referenced by operator()().

◆ GetVariateWithClosedRange() [1/2]

double itk::Statistics::MersenneTwisterRandomVariateGenerator::GetVariateWithClosedRange ( )
inline

Get a random variate in the range [0, 1]

Definition at line 433 of file itkMersenneTwisterRandomVariateGenerator.h.

References GetIntegerVariate().

Referenced by GetVariate(), and GetVariateWithClosedRange().

◆ GetVariateWithClosedRange() [2/2]

double itk::Statistics::MersenneTwisterRandomVariateGenerator::GetVariateWithClosedRange ( const double &  n)
inline

Get a random variate in the range [0, n]

Definition at line 440 of file itkMersenneTwisterRandomVariateGenerator.h.

References GetVariateWithClosedRange().

◆ GetVariateWithOpenRange() [1/2]

double itk::Statistics::MersenneTwisterRandomVariateGenerator::GetVariateWithOpenRange ( )
inline

Get a range variate in the range (0, 1)

Definition at line 461 of file itkMersenneTwisterRandomVariateGenerator.h.

References GetIntegerVariate().

Referenced by GetNormalVariate(), and GetVariateWithOpenRange().

◆ GetVariateWithOpenRange() [2/2]

double itk::Statistics::MersenneTwisterRandomVariateGenerator::GetVariateWithOpenRange ( const double &  n)
inline

Get a range variate in the range (0, n)

Definition at line 468 of file itkMersenneTwisterRandomVariateGenerator.h.

References GetVariateWithOpenRange().

◆ GetVariateWithOpenUpperRange() [1/2]

double itk::Statistics::MersenneTwisterRandomVariateGenerator::GetVariateWithOpenUpperRange ( )
inline

Get a range variate in the range [0, 1)

Definition at line 447 of file itkMersenneTwisterRandomVariateGenerator.h.

References GetIntegerVariate().

Referenced by GetNormalVariate(), GetUniformVariate(), and GetVariateWithOpenUpperRange().

◆ GetVariateWithOpenUpperRange() [2/2]

double itk::Statistics::MersenneTwisterRandomVariateGenerator::GetVariateWithOpenUpperRange ( const double &  n)
inline

Get a range variate in the range [0, n)

Definition at line 454 of file itkMersenneTwisterRandomVariateGenerator.h.

References GetVariateWithOpenUpperRange().

◆ hash()

static IntegerType itk::Statistics::MersenneTwisterRandomVariateGenerator::hash ( time_t  t,
clock_t  c 
)
staticprotected

Period parameter

Referenced by SetSeed().

◆ hiBit()

IntegerType itk::Statistics::MersenneTwisterRandomVariateGenerator::hiBit ( const IntegerType u) const
inlineprotected

Period parameter

Definition at line 278 of file itkMersenneTwisterRandomVariateGenerator.h.

◆ Initialize() [1/2]

void itk::Statistics::MersenneTwisterRandomVariateGenerator::Initialize ( )
inline

Definition at line 388 of file itkMersenneTwisterRandomVariateGenerator.h.

References SetSeed().

Referenced by SetSeed().

◆ Initialize() [2/2]

void itk::Statistics::MersenneTwisterRandomVariateGenerator::Initialize ( const IntegerType  oneSeed)
inline

Initialize with a simple IntegerType

Definition at line 339 of file itkMersenneTwisterRandomVariateGenerator.h.

References m_InstanceLock, m_Seed, reload(), state, and StateVectorLength.

◆ itkGetGlobalDeclarationMacro()

itk::Statistics::MersenneTwisterRandomVariateGenerator::itkGetGlobalDeclarationMacro ( MersenneTwisterGlobals  ,
PimplGlobals   
)
private

Only used to synchronize the global variable across static libraries.

◆ loBit()

IntegerType itk::Statistics::MersenneTwisterRandomVariateGenerator::loBit ( const IntegerType u) const
inlineprotected

Period parameter

Definition at line 283 of file itkMersenneTwisterRandomVariateGenerator.h.

◆ loBits()

IntegerType itk::Statistics::MersenneTwisterRandomVariateGenerator::loBits ( const IntegerType u) const
inlineprotected

Period parameter

Definition at line 288 of file itkMersenneTwisterRandomVariateGenerator.h.

◆ mixBits()

IntegerType itk::Statistics::MersenneTwisterRandomVariateGenerator::mixBits ( const IntegerType u,
const IntegerType v 
) const
inlineprotected

Period parameter

Definition at line 293 of file itkMersenneTwisterRandomVariateGenerator.h.

◆ New()

static Pointer itk::Statistics::MersenneTwisterRandomVariateGenerator::New ( )
static

Method for creation through the object factory.

This method allocates a new instance of a Mersenne Twister, and initializes it with the next seed from the global instance's seed.

Note
This method is thread-safe.
Examples
SphinxExamples/src/Core/ImageFunction/ResampleSegmentedImage/Code.cxx, SphinxExamples/src/Filtering/Colormap/CreateACustomColormap/Code.cxx, and SphinxExamples/src/Segmentation/ConnectedComponents/AssignContiguousLabelsToConnectedRegions/Code.cxx.

Referenced by itk::RandomPermutation::RandomPermutation().

◆ operator()()

double itk::Statistics::MersenneTwisterRandomVariateGenerator::operator() ( )
inline

Same as GetVariate()

Definition at line 537 of file itkMersenneTwisterRandomVariateGenerator.h.

References GetVariate().

◆ PrintSelf()

void itk::Statistics::MersenneTwisterRandomVariateGenerator::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Period parameter

Reimplemented from itk::LightObject.

◆ reload()

void itk::Statistics::MersenneTwisterRandomVariateGenerator::reload ( )
inlineprotected

Reload array with N new values.

Definition at line 361 of file itkMersenneTwisterRandomVariateGenerator.h.

References M, m_Left, m_PNext, state, StateVectorLength, and twist().

Referenced by GetIntegerVariate(), and Initialize().

◆ SetSeed() [1/2]

void itk::Statistics::MersenneTwisterRandomVariateGenerator::SetSeed ( )
inline

Period parameter

Definition at line 401 of file itkMersenneTwisterRandomVariateGenerator.h.

References hash().

Referenced by Initialize().

◆ SetSeed() [2/2]

void itk::Statistics::MersenneTwisterRandomVariateGenerator::SetSeed ( const IntegerType  oneSeed)
inline

Re-seeding functions with same behavior as initializers

\note This method is thread-safe.

Definition at line 394 of file itkMersenneTwisterRandomVariateGenerator.h.

References Initialize().

◆ twist()

IntegerType itk::Statistics::MersenneTwisterRandomVariateGenerator::twist ( const IntegerType m,
const IntegerType s0,
const IntegerType s1 
) const
inlineprotected

Period parameter

Definition at line 299 of file itkMersenneTwisterRandomVariateGenerator.h.

Referenced by reload().

Member Data Documentation

◆ M

constexpr unsigned int itk::Statistics::MersenneTwisterRandomVariateGenerator::M = 397
staticconstexprprotected

Period parameter

Definition at line 271 of file itkMersenneTwisterRandomVariateGenerator.h.

Referenced by reload().

◆ m_InstanceLock

std::mutex itk::Statistics::MersenneTwisterRandomVariateGenerator::m_InstanceLock
private

Period parameter

Definition at line 328 of file itkMersenneTwisterRandomVariateGenerator.h.

Referenced by Initialize().

◆ m_Left

int itk::Statistics::MersenneTwisterRandomVariateGenerator::m_Left
protected

Period parameter

Definition at line 314 of file itkMersenneTwisterRandomVariateGenerator.h.

Referenced by GetIntegerVariate(), and reload().

◆ m_PimplGlobals

MersenneTwisterGlobals* itk::Statistics::MersenneTwisterRandomVariateGenerator::m_PimplGlobals
staticprivate

Period parameter

Definition at line 332 of file itkMersenneTwisterRandomVariateGenerator.h.

◆ m_PNext

IntegerType* itk::Statistics::MersenneTwisterRandomVariateGenerator::m_PNext
protected

Period parameter

Definition at line 311 of file itkMersenneTwisterRandomVariateGenerator.h.

Referenced by GetIntegerVariate(), and reload().

◆ m_Seed

std::atomic<IntegerType> itk::Statistics::MersenneTwisterRandomVariateGenerator::m_Seed
protected

Period parameter

Definition at line 317 of file itkMersenneTwisterRandomVariateGenerator.h.

Referenced by GetSeed(), and Initialize().

◆ state

IntegerType itk::Statistics::MersenneTwisterRandomVariateGenerator::state[StateVectorLength]
protected

Period parameter

Definition at line 308 of file itkMersenneTwisterRandomVariateGenerator.h.

Referenced by Initialize(), and reload().

◆ StateVectorLength

constexpr IntegerType itk::Statistics::MersenneTwisterRandomVariateGenerator::StateVectorLength = 624
staticconstexpr

Length of state vector

Definition at line 164 of file itkMersenneTwisterRandomVariateGenerator.h.

Referenced by Initialize(), and reload().


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