MersenneTwister< K, M, N, F, S > Class Template Reference

Mersenne Twister class for Monte-Carlo simulations. More...

#include <mersenne.h>

Inheritance diagram for MersenneTwister< K, M, N, F, S >:

Public Member Functions
	MersenneTwister (word32 seed=S)
	Construct a Mersenne Twister.
bool	CanIncorporateEntropy () const
	Determines if a generator can accept additional entropy.
void	IncorporateEntropy (const byte *input, size_t length)
	Update RNG state with additional unpredictable values.
void	GenerateBlock (byte *output, size_t size)
	Generate random array of bytes.
word32	GenerateWord32 (word32 min=0, word32 max=0xffffffffL)
	Generate a random 32-bit word in the range min to max, inclusive.
void	DiscardBytes (size_t n)
	Generate and discard n bytes.
Public Member Functions inherited from RandomNumberGenerator
virtual byte	GenerateByte ()
	Generate new random byte and return it.
virtual unsigned int	GenerateBit ()
	Generate new random bit and return it.
virtual void	GenerateIntoBufferedTransformation (BufferedTransformation &target, const std::string &channel, lword length)
	Generate random bytes into a BufferedTransformation.
template<class IT >
void	Shuffle (IT begin, IT end)
	Randomly shuffle the specified array.
Public Member Functions inherited from Algorithm
	Algorithm (bool checkSelfTestStatus=true)
	Interface for all crypto algorithms.
virtual std::string	AlgorithmName () const
	Provides the name of this algorithm.
virtual std::string	AlgorithmProvider () const
	Retrieve the provider of this algorithm.
Public Member Functions inherited from Clonable
virtual Clonable *	Clone () const
	Copies this object.

Static Public Member Functions
static const char *	StaticAlgorithmName ()

Detailed Description

template<unsigned int K, unsigned int M, unsigned int N, unsigned int F, word32 S>
class MersenneTwister< K, M, N, F, S >

Mersenne Twister class for Monte-Carlo simulations.

Template Parameters

K	Magic constant
M	Period parameter
N	Size of the state vector
F	Multiplier constant
S	Initial seed

Provides the MersenneTwister implementation. The class is a header-only implementation.

You should reseed the generator after a fork() to avoid multiple generators with the same internal state.

Warning

MersenneTwister is suitable for simulations, where uniformaly distributed numbers are required quickly. It should not be used for cryptographic purposes.

See also

MT19937, MT19937ar

Since

Crypto++ 5.6.3

Definition at line 31 of file mersenne.h.

Constructor & Destructor Documentation

~MersenneTwister()

template<unsigned int K, unsigned int M, unsigned int N, unsigned int F, word32 S>

MersenneTwister< K, M, N, F, S >::~MersenneTwister ( )

inline

Definition at line 36 of file mersenne.h.

MersenneTwister()

template<unsigned int K, unsigned int M, unsigned int N, unsigned int F, word32 S>

MersenneTwister< K, M, N, F, S >::MersenneTwister ( word32 seed = S )

inline

Construct a Mersenne Twister.

Parameters

seed	32-bit seed

Defaults to template parameter S due to changing algorithm parameters over time

Definition at line 42 of file mersenne.h.

Member Function Documentation

StaticAlgorithmName()

template<unsigned int K, unsigned int M, unsigned int N, unsigned int F, word32 S>

static const char * MersenneTwister< K, M, N, F, S >::StaticAlgorithmName ( )

inlinestatic

Definition at line 34 of file mersenne.h.

CanIncorporateEntropy()

template<unsigned int K, unsigned int M, unsigned int N, unsigned int F, word32 S>

bool MersenneTwister< K, M, N, F, S >::CanIncorporateEntropy ( ) const

inlinevirtual

Determines if a generator can accept additional entropy.

Returns

true if IncorporateEntropy() is implemented

Reimplemented from RandomNumberGenerator.

Definition at line 47 of file mersenne.h.

IncorporateEntropy()

template<unsigned int K, unsigned int M, unsigned int N, unsigned int F, word32 S>

void MersenneTwister< K, M, N, F, S >::IncorporateEntropy ( const byte * input, size_t length )

inlinevirtual

Update RNG state with additional unpredictable values.

Parameters

input	the entropy to add to the generator
length	the size of the input buffer

MersenneTwister uses the first 32-bits of input to reseed the generator. If fewer bytes are provided, then the seed is padded with 0's.

Reimplemented from RandomNumberGenerator.

Definition at line 54 of file mersenne.h.

GenerateBlock()

template<unsigned int K, unsigned int M, unsigned int N, unsigned int F, word32 S>

void MersenneTwister< K, M, N, F, S >::GenerateBlock ( byte * output, size_t size )

inlinevirtual

Generate random array of bytes.

Parameters

output	byte buffer
size	length of the buffer, in bytes

Bytes are written to output in big endian order. If output length is not a multiple of word32, then unused bytes are not accumulated for subsequent calls to GenerateBlock. Rather, the unused tail bytes are discarded, and the stream is continued at the next word32 boundary from the state array.

Reimplemented from RandomNumberGenerator.

Definition at line 79 of file mersenne.h.

GenerateWord32()

template<unsigned int K, unsigned int M, unsigned int N, unsigned int F, word32 S>

word32 MersenneTwister< K, M, N, F, S >::GenerateWord32 ( word32 min = 0, word32 max = 0xffffffffL )

inlinevirtual

Generate a random 32-bit word in the range min to max, inclusive.

Returns

random 32-bit word in the range min to max, inclusive

If the 32-bit candidate is not within the range, then it is discarded and a new candidate is used.

Reimplemented from RandomNumberGenerator.

Definition at line 109 of file mersenne.h.

DiscardBytes()

template<unsigned int K, unsigned int M, unsigned int N, unsigned int F, word32 S>

void MersenneTwister< K, M, N, F, S >::DiscardBytes ( size_t n )

inlinevirtual

Generate and discard n bytes.

Parameters

n	the number of bytes to discard, rounded up to a word32 size

If n is not a multiple of word32, then unused bytes are not accumulated for subsequent calls to GenerateBlock. Rather, the unused tail bytes are discarded, and the stream is continued at the next word32 boundary from the state array.

Reimplemented from RandomNumberGenerator.

Definition at line 131 of file mersenne.h.

---

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

• mersenne.h