clarify the working between SeedManager set/get seed and the underlying package seed, in comments
authorTom Henderson <tomh@tomh.org>
Sun Mar 01 11:17:30 2009 -0800 (11 months ago)
changeset 4247d1b2785e4509
parent 4246 b61705329366
child 4248 6e0c97efccd0
clarify the working between SeedManager set/get seed and the underlying package seed, in comments
src/core/random-variable.h
     1.1 --- a/src/core/random-variable.h	Sun Mar 01 11:16:39 2009 -0800
     1.2 +++ b/src/core/random-variable.h	Sun Mar 01 11:17:30 2009 -0800
     1.3 @@ -53,12 +53,18 @@
     1.4     * ExponentialVariable y(120); //as long as the seed stays the same
     1.5     * \endcode
     1.6     * \param seed
     1.7 +   *
     1.8 +   * Note, while the underlying RNG takes six integer values as a seed;
     1.9 +   * it is sufficient to set these all to the same integer, so we provide
    1.10 +   * a simpler interface here that just takes one integer.
    1.11     */ 
    1.12    static void SetSeed (uint32_t seed);
    1.13   
    1.14    /**
    1.15     * \brief Get the seed value
    1.16     * \return the seed value
    1.17 +   *
    1.18 +   * Note:  returns the first of the six seed values used in the underlying RNG
    1.19     */
    1.20     static uint32_t GetSeed ();
    1.21