Main Page Groups Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Concepts

itk::Statistics::MersenneTwisterRandomVariateGenerator Class Reference

MersenneTwisterRandom random variate generator. More...

#include <itkMersenneTwisterRandomVariateGenerator.h>

Inheritance diagram for itk::Statistics::MersenneTwisterRandomVariateGenerator:

[legend]Collaboration diagram for itk::Statistics::MersenneTwisterRandomVariateGenerator:

[legend]List of all members.


Public Types
typedef MersenneTwisterRandomVariateGenerator	Self
typedef RandomVariateGeneratorBase	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef ITK_UINT32	IntegerType
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (StateVectorLength, IntegerType, 624)
void	Initialize (const IntegerType oneSeed)
void	Initialize ()
double	GetNormalVariate (const double &mean=0.0, const double &variance=1.0)
double	GetUniformVariate (const double &a, const double &b)
virtual double	GetVariate ()
double	operator() ()
void	SetSeed (const IntegerType oneSeed)
void	SetSeed (IntegerType *bigSeed, const IntegerType seedLength=StateVectorLength)
void	SetSeed ()

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 ()
Static Public Member Functions

Pointer	New ()
Pointer	GetInstance ()
Protected Member Functions
	MersenneTwisterRandomVariateGenerator ()
virtual	~MersenneTwisterRandomVariateGenerator ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
	itkStaticConstMacro (M, unsigned int, 397)
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 Protected Member Functions
IntegerType	hash (vcl_time_t t, vcl_clock_t c)
Protected Attributes
IntegerType	state [StateVectorLength]
IntegerType *	pNext
int	left
Static Protected Attributes
Pointer	m_Instance

Detailed Description

MersenneTwisterRandom random variate generator.

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.

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.

Definition at line 97 of file itkMersenneTwisterRandomVariateGenerator.h.

Member Typedef Documentation

typedef SmartPointer<const Self> itk::Statistics::MersenneTwisterRandomVariateGenerator::ConstPointer

Reimplemented from itk::Statistics::RandomVariateGeneratorBase.
Definition at line 106 of file itkMersenneTwisterRandomVariateGenerator.h.

typedef ITK_UINT32 itk::Statistics::MersenneTwisterRandomVariateGenerator::IntegerType

Definition at line 107 of file itkMersenneTwisterRandomVariateGenerator.h.
Referenced by Get53BitVariate(), GetIntegerVariate(), hash(), hiBit(), Initialize(), loBit(), loBits(), PrintSelf(), reload(), and SetSeed().

typedef SmartPointer<Self> itk::Statistics::MersenneTwisterRandomVariateGenerator::Pointer

Reimplemented from itk::Statistics::RandomVariateGeneratorBase.
Definition at line 105 of file itkMersenneTwisterRandomVariateGenerator.h.

typedef MersenneTwisterRandomVariateGenerator itk::Statistics::MersenneTwisterRandomVariateGenerator::Self

Standard class typedefs.
Reimplemented from itk::Statistics::RandomVariateGeneratorBase.
Definition at line 103 of file itkMersenneTwisterRandomVariateGenerator.h.

typedef RandomVariateGeneratorBase itk::Statistics::MersenneTwisterRandomVariateGenerator::Superclass

Reimplemented from itk::Statistics::RandomVariateGeneratorBase.
Definition at line 104 of file itkMersenneTwisterRandomVariateGenerator.h.

Constructor & Destructor Documentation

itk::Statistics::MersenneTwisterRandomVariateGenerator::MersenneTwisterRandomVariateGenerator ( ) [inline, protected]

Definition at line 561 of file itkMersenneTwisterRandomVariateGenerator.h.

virtual itk::Statistics::MersenneTwisterRandomVariateGenerator::~MersenneTwisterRandomVariateGenerator ( ) [inline, protected, virtual]

Definition at line 201 of file itkMersenneTwisterRandomVariateGenerator.h.

Member Function Documentation

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 511 of file itkMersenneTwisterRandomVariateGenerator.h.
References IntegerType.

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

Method for creation through the object factory.

MersenneTwisterRandomVariateGenerator::IntegerType itk::Statistics::MersenneTwisterRandomVariateGenerator::GetIntegerVariate ( const IntegerType & n ) [inline]

Get an integer variate in [0, n] for n < 2^32
Definition at line 484 of file itkMersenneTwisterRandomVariateGenerator.h.
References GetIntegerVariate(), and IntegerType.

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

Get an integer variate in [0, 2^32-1]
Definition at line 422 of file itkMersenneTwisterRandomVariateGenerator.h.
References IntegerType, left, pNext, and reload().
Referenced by GetIntegerVariate().

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

Run-time type information (and related methods).
Reimplemented from itk::Statistics::RandomVariateGeneratorBase.

double itk::Statistics::MersenneTwisterRandomVariateGenerator::GetNormalVariate ( const double & mean = 0.0,

const double & variance = 1.0

) [inline]

Definition at line 522 of file itkMersenneTwisterRandomVariateGenerator.h.

double itk::Statistics::MersenneTwisterRandomVariateGenerator::GetUniformVariate ( const double & a,

const double & b

) [inline]

Definition at line 538 of file itkMersenneTwisterRandomVariateGenerator.h.

double itk::Statistics::MersenneTwisterRandomVariateGenerator::GetVariate ( ) [inline, virtual]

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 547 of file itkMersenneTwisterRandomVariateGenerator.h.

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

Get a random variate in the range [0, n]
Definition at line 445 of file itkMersenneTwisterRandomVariateGenerator.h.

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

Get a random variate in the range [0, 1]
Definition at line 438 of file itkMersenneTwisterRandomVariateGenerator.h.

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

Get a range variate in the range (0, n)
Definition at line 476 of file itkMersenneTwisterRandomVariateGenerator.h.
References GetVariateWithOpenRange().

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

Get a range variate in the range (0, 1)
Definition at line 468 of file itkMersenneTwisterRandomVariateGenerator.h.
Referenced by GetVariateWithOpenRange().

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

Get a range variate in the range [0, n)
Definition at line 460 of file itkMersenneTwisterRandomVariateGenerator.h.
References GetVariateWithOpenUpperRange().

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

Get a range variate in the range [0, 1)
Definition at line 453 of file itkMersenneTwisterRandomVariateGenerator.h.
Referenced by GetVariateWithOpenUpperRange().

MersenneTwisterRandomVariateGenerator::IntegerType itk::Statistics::MersenneTwisterRandomVariateGenerator::hash ( vcl_time_t t,

vcl_clock_t c

) [inline, static, protected]

Definition at line 253 of file itkMersenneTwisterRandomVariateGenerator.h.
References IntegerType.
Referenced by SetSeed().

IntegerType itk::Statistics::MersenneTwisterRandomVariateGenerator::hiBit ( const IntegerType & u ) const [inline, protected]

Definition at line 231 of file itkMersenneTwisterRandomVariateGenerator.h.
References IntegerType.

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

Initialize with an array
Definition at line 377 of file itkMersenneTwisterRandomVariateGenerator.h.
References SetSeed().
Referenced by SetSeed().

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

initialize with a simple IntegerType
Definition at line 280 of file itkMersenneTwisterRandomVariateGenerator.h.
References IntegerType, and state.

itk::Statistics::MersenneTwisterRandomVariateGenerator::itkStaticConstMacro ( M ,

unsigned int,

397

) [protected]

itk::Statistics::MersenneTwisterRandomVariateGenerator::itkStaticConstMacro ( StateVectorLength ,

IntegerType ,

624

)

Length of state vector

IntegerType itk::Statistics::MersenneTwisterRandomVariateGenerator::loBit ( const IntegerType & u ) const [inline, protected]

Definition at line 232 of file itkMersenneTwisterRandomVariateGenerator.h.
References IntegerType.

IntegerType itk::Statistics::MersenneTwisterRandomVariateGenerator::loBits ( const IntegerType & u ) const [inline, protected]

Definition at line 233 of file itkMersenneTwisterRandomVariateGenerator.h.
References IntegerType.

IntegerType itk::Statistics::MersenneTwisterRandomVariateGenerator::mixBits ( const IntegerType & u,

const IntegerType & v

) const [inline, protected]

Definition at line 234 of file itkMersenneTwisterRandomVariateGenerator.h.

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

Method for creation through the object factory.
Reimplemented from itk::Object.

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

Same as GetVariate()
Definition at line 554 of file itkMersenneTwisterRandomVariateGenerator.h.

virtual void itk::Statistics::MersenneTwisterRandomVariateGenerator::PrintSelf ( std::ostream & os,

Indent indent

) const [inline, protected, virtual]

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 itk::Object.
Definition at line 202 of file itkMersenneTwisterRandomVariateGenerator.h.
References IntegerType.

void itk::Statistics::MersenneTwisterRandomVariateGenerator::reload ( ) [inline, protected]

Definition at line 298 of file itkMersenneTwisterRandomVariateGenerator.h.
References IntegerType, left, pNext, state, and twist().
Referenced by GetIntegerVariate(), and SetSeed().

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

Definition at line 393 of file itkMersenneTwisterRandomVariateGenerator.h.
References hash().
Referenced by Initialize().

void itk::Statistics::MersenneTwisterRandomVariateGenerator::SetSeed ( IntegerType * bigSeed,

const IntegerType seedLength = StateVectorLength

) [inline]

Definition at line 327 of file itkMersenneTwisterRandomVariateGenerator.h.
References Initialize(), IntegerType, reload(), state, and SVL.

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

Definition at line 384 of file itkMersenneTwisterRandomVariateGenerator.h.
References Initialize(), and reload().

IntegerType itk::Statistics::MersenneTwisterRandomVariateGenerator::twist ( const IntegerType & m,

const IntegerType & s0,

const IntegerType & s1

) const [inline, protected]

Definition at line 238 of file itkMersenneTwisterRandomVariateGenerator.h.
Referenced by reload().