Mersenne Twister class for Monte-Carlo simulations. More...
Public Member Functions | |
MersenneTwister (unsigned long seed=S) | |
Construct a Mersenne Twister. | |
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. | |
virtual void | IncorporateEntropy (const byte *input, size_t length) |
Update RNG state with additional unpredictable values. | |
virtual bool | CanIncorporateEntropy () const |
Determines if a generator can accept additional entropy. | |
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. | |
virtual std::string | AlgorithmName () const |
Provides the name of this algorithm. | |
virtual Clonable * | Clone () const |
Copies this object. |
Mersenne Twister class for Monte-Carlo simulations.
K | Magic constant | |
M | Period parameter | |
N | Size of the state vector | |
F | Multiplier constant | |
S | Sefault seed |
Provides the MersenneTwister implementation. The class is a header-only implementation.
Definition at line 28 of file mersenne.h.
MersenneTwister< K, M, N, F, S >::MersenneTwister | ( | unsigned long | seed = S |
) | [inline] |
Construct a Mersenne Twister.
seed | 32-bit seed |
Defaults to template parameter S due to changing algorithm parameters over time
Definition at line 35 of file mersenne.h.
void MersenneTwister< K, M, N, F, S >::GenerateBlock | ( | byte * | output, | |
size_t | size | |||
) | [inline, virtual] |
Generate random array of bytes.
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 49 of file mersenne.h.
References ByteReverse().
word32 MersenneTwister< K, M, N, F, S >::GenerateWord32 | ( | word32 | min = 0 , |
|
word32 | max = 0xffffffffL | |||
) | [inline, virtual] |
Generate a 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 95 of file mersenne.h.
References BitPrecision(), and Crop().
void MersenneTwister< K, M, N, F, S >::DiscardBytes | ( | size_t | n | ) | [inline, virtual] |
Generate and discard n bytes.
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 117 of file mersenne.h.
References RoundUpToMultipleOf().
virtual void RandomNumberGenerator::IncorporateEntropy | ( | const byte * | input, | |
size_t | length | |||
) | [inline, virtual, inherited] |
Update RNG state with additional unpredictable values.
input | the entropy to add to the generator | |
length | the size of the input buffer |
NotImplemented |
A generator may or may not accept additional entropy. Call CanIncorporateEntropy() to test for the ability to use additional entropy.
If a derived class does not override IncorporateEntropy(), then the base class throws NotImplemented.
Reimplemented in ClassNullRNG, AutoSeededX917RNG< BLOCK_CIPHER >, RandomPool, RDRAND, and RDSEED.
Definition at line 1096 of file cryptlib.h.
Referenced by RandomNumberSink::Put2(), and DL_SignerBase< SCHEME_OPTIONS::Element >::SignAndRestart().
virtual bool RandomNumberGenerator::CanIncorporateEntropy | ( | ) | const [inline, virtual, inherited] |
Determines if a generator can accept additional entropy.
Reimplemented in ClassNullRNG, AutoSeededX917RNG< BLOCK_CIPHER >, and RandomPool.
Definition at line 1104 of file cryptlib.h.
Referenced by DL_SignerBase< SCHEME_OPTIONS::Element >::SignAndRestart().
byte RandomNumberGenerator::GenerateByte | ( | ) | [virtual, inherited] |
Generate new random byte and return it.
Default implementation calls GenerateBlock() with one byte.
All generated values are uniformly distributed over the range specified within the the contraints of a particular generator.
Reimplemented in PublicBlumBlumShub, and ClassNullRNG.
Definition at line 294 of file cryptlib.cpp.
References RandomNumberGenerator::GenerateBlock().
Referenced by RandomNumberGenerator::GenerateBit().
unsigned int RandomNumberGenerator::GenerateBit | ( | ) | [virtual, inherited] |
Generate new random bit and return it.
The default implementation calls GenerateByte() and return its lowest bit.
All generated values are uniformly distributed over the range specified within the the contraints of a particular generator.
Reimplemented in PublicBlumBlumShub, and ClassNullRNG.
Definition at line 289 of file cryptlib.cpp.
References RandomNumberGenerator::GenerateByte().
void RandomNumberGenerator::GenerateIntoBufferedTransformation | ( | BufferedTransformation & | target, | |
const std::string & | channel, | |||
lword | length | |||
) | [virtual, inherited] |
Generate random bytes into a BufferedTransformation.
target | the BufferedTransformation object which receives the bytes | |
channel | the channel on which the bytes should be pumped | |
length | the number of bytes to generate |
The default implementation calls GenerateBlock() and pumps the result into the DEFAULT_CHANNEL of the target.
All generated values are uniformly distributed over the range specified within the the contraints of a particular generator.
Reimplemented in ClassNullRNG, AutoSeededX917RNG< BLOCK_CIPHER >, RandomPool, and X917RNG.
Definition at line 347 of file cryptlib.cpp.
References BufferedTransformation::ChannelPut(), RandomNumberGenerator::GenerateBlock(), SecBlock< T, A >::size(), and UnsignedMin().
Referenced by RandomNumberGenerator::DiscardBytes(), and RandomNumberGenerator::GenerateBlock().
void RandomNumberGenerator::Shuffle | ( | IT | begin, | |
IT | end | |||
) | [inline, inherited] |
Randomly shuffle the specified array.
begin | an iterator to the first element in the array | |
end | an iterator beyond the last element in the array |
The resulting permutation is uniformly distributed.
Reimplemented in ClassNullRNG.
Definition at line 1159 of file cryptlib.h.
virtual std::string Algorithm::AlgorithmName | ( | ) | const [inline, virtual, inherited] |
Provides the name of this algorithm.
The standard algorithm name can be a name like AES or AES/GCM. Some algorithms do not have standard names yet. For example, there is no standard algorithm name for Shoup's ECIES.
Reimplemented in Adler32, CCM_Base, CRC32, ClassNullRNG, AuthenticatedSymmetricCipher, DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >, EAX_Base, StreamTransformationFilter, HashFilter, HashVerificationFilter, AuthenticatedDecryptionFilter, SignerFilter, SignatureVerificationFilter, GCM_Base, HMAC< T >, RDRAND, RDSEED, SHA3, BitBucket, and VMAC_Base.
Definition at line 488 of file cryptlib.h.
Referenced by BufferedTransformation::ChannelCreatePutSpace(), BufferedTransformation::ChannelFlush(), BufferedTransformation::ChannelMessageSeriesEnd(), BufferedTransformation::ChannelPut2(), TF_DecryptorBase::Decrypt(), TF_EncryptorBase::Encrypt(), StreamTransformation::ProcessLastBlock(), and PK_DefaultDecryptionFilter::Put2().
virtual Clonable* Clonable::Clone | ( | ) | const [inline, virtual, inherited] |
Copies this object.
NotImplemented |
Definition at line 464 of file cryptlib.h.