clarify the working between SeedManager set/get seed and the underlying package seed, in comments

This commit is contained in:
Tom Henderson
2009-03-01 11:17:30 -08:00
parent ba3641f90f
commit 6caf2a0b2e

View File

@@ -53,12 +53,18 @@ public:
* ExponentialVariable y(120); //as long as the seed stays the same
* \endcode
* \param seed
*
* Note, while the underlying RNG takes six integer values as a seed;
* it is sufficient to set these all to the same integer, so we provide
* a simpler interface here that just takes one integer.
*/
static void SetSeed (uint32_t seed);
/**
* \brief Get the seed value
* \return the seed value
*
* Note: returns the first of the six seed values used in the underlying RNG
*/
static uint32_t GetSeed ();