#include <itkMersenneTwisterRandomVariateGenerator.h>
Inheritance diagram for itk::Statistics::MersenneTwisterRandomVariateGenerator:


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.
Definition at line 97 of file itkMersenneTwisterRandomVariateGenerator.h.
Public Types | |
| typedef SmartPointer< const Self > | ConstPointer |
| typedef ITK_UINT32 | IntegerType |
| typedef SmartPointer< Self > | Pointer |
| typedef MersenneTwisterRandomVariateGenerator | Self |
| typedef RandomVariateGeneratorBase | Superclass |
Public Member Functions | |
| virtual LightObject::Pointer | CreateAnother () const |
| virtual void | DebugOff () const |
| virtual void | DebugOn () const |
| virtual void | Delete () |
| double | Get53BitVariate () |
| Command * | GetCommand (unsigned long tag) |
| bool | GetDebug () const |
| IntegerType | GetIntegerVariate (const IntegerType &n) |
| IntegerType | GetIntegerVariate () |
| const MetaDataDictionary & | GetMetaDataDictionary (void) const |
| MetaDataDictionary & | GetMetaDataDictionary (void) |
| virtual unsigned long | GetMTime () const |
| virtual const char * | GetNameOfClass () const |
| double | GetNormalVariate (const double &mean=0.0, const double &variance=1.0) |
| virtual int | GetReferenceCount () const |
| double | GetUniformVariate (const double &a, const double &b) |
| virtual double | GetVariate () |
| double | GetVariateWithClosedRange (const double &n) |
| double | GetVariateWithClosedRange () |
| double | GetVariateWithOpenRange (const double &n) |
| double | GetVariateWithOpenRange () |
| double | GetVariateWithOpenUpperRange (const double &n) |
| double | GetVariateWithOpenUpperRange () |
| bool | HasObserver (const EventObject &event) const |
| void | Initialize () |
| void | Initialize (const IntegerType oneSeed) |
| void | InvokeEvent (const EventObject &) const |
| void | InvokeEvent (const EventObject &) |
| itkStaticConstMacro (StateVectorLength, IntegerType, 624) | |
| virtual void | Modified () const |
| double | operator() () |
| void | Print (std::ostream &os, Indent indent=0) const |
| virtual void | Register () const |
| void | RemoveAllObservers () |
| void | RemoveObserver (unsigned long tag) |
| void | SetDebug (bool debugFlag) const |
| void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
| virtual void | SetReferenceCount (int) |
| void | SetSeed () |
| void | SetSeed (IntegerType *bigSeed, const IntegerType seedLength=StateVectorLength) |
| void | SetSeed (const IntegerType oneSeed) |
| virtual void | UnRegister () const |
Static Public Member Functions | |
| static void | BreakOnError () |
| static bool | GetGlobalWarningDisplay () |
| static Pointer | GetInstance () |
| static void | GlobalWarningDisplayOff () |
| static void | GlobalWarningDisplayOn () |
| Method for creation through the object factory *static Pointer | New () |
| This is a global flag that controls whether any warning *or error messages are displayed *static void | SetGlobalWarningDisplay (bool flag) |
Public Attributes | |
| Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon | AddObserver )(const EventObject &event, Command *) const |
| This is a global flag that controls whether any | debug |
Protected Member Functions | |
| IntegerType | hiBit (const IntegerType &u) const |
| itkStaticConstMacro (M, unsigned int, 397) | |
| IntegerType | loBit (const IntegerType &u) const |
| IntegerType | loBits (const IntegerType &u) const |
| MersenneTwisterRandomVariateGenerator () | |
| IntegerType | mixBits (const IntegerType &u, const IntegerType &v) const |
| bool | PrintObservers (std::ostream &os, Indent indent) const |
| virtual void | PrintSelf (std::ostream &os, Indent indent) const |
| virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
| void | reload () |
| IntegerType | twist (const IntegerType &m, const IntegerType &s0, const IntegerType &s1) const |
| virtual | ~MersenneTwisterRandomVariateGenerator () |
Static Protected Member Functions | |
| static IntegerType | hash (vcl_time_t t, vcl_clock_t c) |
Protected Attributes | |
| int | left |
| int | m_ReferenceCount |
| SimpleFastMutexLock | m_ReferenceCountLock |
| IntegerType * | pNext |
| Methods invoked by virtual 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.*/virtual void PrintSelf(std voi | PrintHeader )(std::ostream &os, Indent indent) const |
| IntegerType | state [StateVectorLength] |
Static Protected Attributes | |
| static Pointer | m_Instance |
|
|
Reimplemented from itk::Statistics::RandomVariateGeneratorBase. Definition at line 106 of file itkMersenneTwisterRandomVariateGenerator.h. |
|
|
Definition at line 107 of file itkMersenneTwisterRandomVariateGenerator.h. |
|
|
Reimplemented from itk::Statistics::RandomVariateGeneratorBase. Definition at line 105 of file itkMersenneTwisterRandomVariateGenerator.h. |
|
|
Standard class typedefs. Reimplemented from itk::Statistics::RandomVariateGeneratorBase. Definition at line 103 of file itkMersenneTwisterRandomVariateGenerator.h. |
|
|
Reimplemented from itk::Statistics::RandomVariateGeneratorBase. Definition at line 104 of file itkMersenneTwisterRandomVariateGenerator.h. |
|
|
Definition at line 561 of file itkMersenneTwisterRandomVariateGenerator.h. References SetSeed(). |
|
|
Definition at line 201 of file itkMersenneTwisterRandomVariateGenerator.h. |
|
|
This method is called when itkExceptionMacro executes. It allows the debugger to break on error. |
|
|
Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class. Reimplemented from itk::LightObject. |
|
|
Turn debugging output off. |
|
|
Turn debugging output on. |
|
|
Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting. |
|
|
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 GetIntegerVariate(). |
|
|
Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used. |
|
|
Get the value of the debug flag. |
|
|
|
|
|
|
|
|
Get an integer variate in [0, n] for n < 2^32 Definition at line 484 of file itkMersenneTwisterRandomVariateGenerator.h. References GetIntegerVariate(), and itk::fem::used. |
|
|
Get an integer variate in [0, 2^32-1] Referenced by Get53BitVariate(), GetIntegerVariate(), GetVariateWithClosedRange(), GetVariateWithOpenRange(), and GetVariateWithOpenUpperRange(). |
|
|
|
|
|
|
|
|
|
Run-time type information (and related methods). Reimplemented from itk::Statistics::RandomVariateGeneratorBase. |
|
||||||||||||
|
Definition at line 522 of file itkMersenneTwisterRandomVariateGenerator.h. References GetVariateWithOpenRange(), and GetVariateWithOpenUpperRange(). |
|
|
Gets the reference count on this object. Definition at line 98 of file itkLightObject.h. |
|
||||||||||||
|
Definition at line 538 of file itkMersenneTwisterRandomVariateGenerator.h. References GetVariateWithOpenUpperRange(). |
|
|
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. References GetVariateWithClosedRange(). Referenced by operator()(). |
|
|
Get a random variate in the range [0, n] Definition at line 445 of file itkMersenneTwisterRandomVariateGenerator.h. |
|
|
Get a random variate in the range [0, 1] Definition at line 438 of file itkMersenneTwisterRandomVariateGenerator.h. References GetIntegerVariate(). Referenced by GetVariate(). |
|
|
Get a range variate in the range (0, n) Definition at line 476 of file itkMersenneTwisterRandomVariateGenerator.h. References GetVariateWithOpenRange(). |
|
|
Get a range variate in the range (0, 1) Definition at line 468 of file itkMersenneTwisterRandomVariateGenerator.h. References GetIntegerVariate(). Referenced by GetNormalVariate(), and GetVariateWithOpenRange(). |
|
|
Get a range variate in the range [0, n) Definition at line 460 of file itkMersenneTwisterRandomVariateGenerator.h. References GetVariateWithOpenUpperRange(). |
|
|
Get a range variate in the range [0, 1) Definition at line 453 of file itkMersenneTwisterRandomVariateGenerator.h. References GetIntegerVariate(). Referenced by GetNormalVariate(), GetUniformVariate(), and GetVariateWithOpenUpperRange(). |
|
|
Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay(). |
|
|
Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay(). |
|
||||||||||||
|
Definition at line 253 of file itkMersenneTwisterRandomVariateGenerator.h. Referenced by SetSeed(). |
|
|
Return true if an observer is registered for this event. |
|
|
Definition at line 231 of file itkMersenneTwisterRandomVariateGenerator.h. |
|
|
Initialize with an array Definition at line 377 of file itkMersenneTwisterRandomVariateGenerator.h. References SetSeed(). Referenced by SetSeed(). |
|
|
initialize with a simple IntegerType Definition at line 280 of file itkMersenneTwisterRandomVariateGenerator.h. |
|
|
Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object. |
|
|
Call Execute on all the Commands observing this event id. |
|
||||||||||||||||
|
|
|
||||||||||||||||
|
Length of state vector |
|
|
Definition at line 232 of file itkMersenneTwisterRandomVariateGenerator.h. |
|
|
Definition at line 233 of file itkMersenneTwisterRandomVariateGenerator.h. |
|
||||||||||||
|
Definition at line 234 of file itkMersenneTwisterRandomVariateGenerator.h. |
|
|
|
Method for creation through the object factory. Reimplemented from itk::Object. |
|
|
Same as GetVariate() Definition at line 554 of file itkMersenneTwisterRandomVariateGenerator.h. References GetVariate(). |
|
||||||||||||
|
Cause the object to print itself out. |
|
||||||||||||
|
|
|
||||||||||||
|
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 HardConnectedComponentImageFilter::PrintSelf(), and itk::s. |
|
||||||||||||
|
|
|
|
Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject. |
|
|
Definition at line 298 of file itkMersenneTwisterRandomVariateGenerator.h. References left, pNext, state, and twist(). Referenced by SetSeed(). |
|
|
Remove all observers . |
|
|
Remove the observer with this tag value. |
|
|
Set the value of the debug flag. A non-zero value turns debugging on. |
|
|
Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn(). |
|
|
|
|
|
Sets the reference count (use with care) Reimplemented from itk::LightObject. |
|
|
Definition at line 393 of file itkMersenneTwisterRandomVariateGenerator.h. References hash(). Referenced by Initialize(), and MersenneTwisterRandomVariateGenerator(). |
|
||||||||||||
|
Definition at line 327 of file itkMersenneTwisterRandomVariateGenerator.h. References Initialize(), reload(), state, and SVL. |
|
|
Definition at line 384 of file itkMersenneTwisterRandomVariateGenerator.h. References Initialize(), and reload(). |
|
||||||||||||||||
|
Definition at line 238 of file itkMersenneTwisterRandomVariateGenerator.h. Referenced by reload(). |
|
|
Decrease the reference count (release by another object). Reimplemented from itk::LightObject. |
|
|
|
|
|
Definition at line 94 of file itkObject.h. |
|
|
Definition at line 226 of file itkMersenneTwisterRandomVariateGenerator.h. Referenced by reload(). |
|
|
Definition at line 243 of file itkMersenneTwisterRandomVariateGenerator.h. |
|
|
Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h. |
|
|
Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h. |
|
|
Definition at line 225 of file itkMersenneTwisterRandomVariateGenerator.h. Referenced by reload(). |
|
|
|
|
|
Definition at line 224 of file itkMersenneTwisterRandomVariateGenerator.h. Referenced by Initialize(), reload(), and SetSeed(). |
1.4.2 written by Dimitri van Heesch,
© 1997-2000