diff options
author | Jeffrey Walton <noloader@gmail.com> | 2015-11-22 19:11:31 -0500 |
---|---|---|
committer | Jeffrey Walton <noloader@gmail.com> | 2015-11-22 19:11:31 -0500 |
commit | 62618fda97bbde6d4cc4752101e69839fc4f3b6f (patch) | |
tree | bcdacdfed312bb5ac9e4c504ff2a3c293214fe40 /mersenne.h | |
parent | c45435812225aa68d122c7de246e5f60b509766c (diff) | |
download | cryptopp-git-62618fda97bbde6d4cc4752101e69839fc4f3b6f.tar.gz |
Revert botched "Crypto++ 5.6.3 check-in". Corruption due to VMware adding garbage to the end of some source files during drag and drop from guest to host.
This reverts commit c45435812225aa68d122c7de246e5f60b509766c.
Diffstat (limited to 'mersenne.h')
-rw-r--r-- | mersenne.h | 14 |
1 files changed, 5 insertions, 9 deletions
@@ -1,9 +1,7 @@ -// mersenne.h - written and placed in public domain by Jeffrey Walton.
-// Copyright assigned to Crypto++ project.
+// mersenne.h - written and placed in public domain by Jeffrey Walton. Copyright assigned to Crypto++ project.
//! \file
-//! \brief Class file for Mersenne Twister
-//! \note Suitable for Monte Carlo simulations, and not cryptographic use
+//! \brief Implementation of the Mersenne Twister
#ifndef CRYPTOPP_MERSENNE_TWISTER_H
#define CRYPTOPP_MERSENNE_TWISTER_H
@@ -27,7 +25,7 @@ class MersenneTwister : public RandomNumberGenerator {
public:
//! \brief Construct a Mersenne Twister
- //! \param seed 32-bit seed
+ //! \param seed 32 bit seed
//! \details Defaults to template parameter \p S due to changing algorithm
//! parameters over time
MersenneTwister(unsigned long seed = S) : m_seed(seed), m_idx(N)
@@ -86,9 +84,8 @@ public: *((volatile word32*)&temp) = 0;
}
- //! \brief 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
- //! \details If the 32-bit candidate is not within the range, then it is discarded
+ //! \brief Generate a random 32 bit word in the range min to max, inclusive
+ //! \details If the 32 bit candidate is not within the range, then it is discarded
//! and a new candidate is used.
word32 GenerateWord32(word32 min=0, word32 max=0xffffffffL)
{
@@ -121,7 +118,6 @@ public: protected:
//! \brief Returns the next 32-bit word from the state array
- //! \returns the next 32-bit word from the state array
//! \details fetches the next word frm the state array, performs bit operations on
//! it, and then returns the value to the caller.
word32 NextMersenneWord()
|