clarify the working between SeedManager set/get seed and the underlying package seed, in comments
authorTom Henderson <tomh@tomh.org>
Sun, 01 Mar 2009 11:17:30 -0800
changeset 4247 d1b2785e4509
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
--- a/src/core/random-variable.h	Sun Mar 01 11:16:39 2009 -0800
+++ b/src/core/random-variable.h	Sun Mar 01 11:17:30 2009 -0800
@@ -53,12 +53,18 @@
    * 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 ();