Changeset 379 for trunk/lib/random/random.h

Timestamp:

Aug 8, 2005, 4:39:24 PM (17 years ago)

Author:

Peter

Message:

removed min parameter in uniform_int and added test to rnd_test

File:

• trunk/lib/random/random.h (modified) (6 diffs)

trunk/lib/random/random.h

@@ -27 +27 @@
   /// There are many different rng's available in GSL. Currently only
   /// the default generator is implemented and no other one is
-  /// choosable though the class interface. This means that you have
+  /// choosable through the class interface. This means that you have
   /// to fall back to the use of environment variables as described in
   /// the GSL documentation, or be bold and request support for other
@@ -251 +251 @@
     /// @return A random number.
     ///
-    virtual long operator()(void) const = 0;
+    virtual u_long operator()(void) const = 0;
     
   protected:
@@ -262 +262 @@
   /// Discrete uniform distribution also known as the "equally likely
   /// outcomes" distribution. Each outcome, in this case an integer
-  /// from \f$ [a,b) \f$, have equal probability to occur.
+  /// from [a,b) , have equal probability to occur.
   ///
   /// Distribution function \f$ p(k) = \frac{1}{b-a} \f$ for \f$ a \le
   /// k < b \f$ \n 
-  /// Expectation value: \f$ \frac{a+b}{2} \f$ \n 
+  /// Expectation value: \f$ \frac{a+b-1}{2} \f$ \n 
   /// Variance: \f$ \frac{1}{3}((b-a)^2-1) \f$
   ///
@@ -276 +276 @@
     /// @brief Constructor.
     ///
-    /// @todo The default behaviour of the underlying RNG should be
-    /// setup when this constructor is used.
-    ///
-    inline DiscreteUniform(void)
-      : min_(0), range_(0) {}
+    DiscreteUniform(void);
 
     ///
     /// @brief Constructor.
     ///
-    /// @param \a range is number of different integers that can be
-    /// generated \f$ (b-a+1) \f$ \a min is the minimal integer that
-    /// can be generated \f$ (a) \f$
-    ///
-    inline DiscreteUniform(const u_long range, const long min=0) 
-      : min_(min), range_(range) {}
-
-    ///
-    /// @return A random number between \a min_ and \a range_ - \a min_
-    ///
-    inline long operator()(void) const 
-    { return gsl_rng_uniform_int(rng_->rng(), range_)+min_; }
-
-    ///
-    /// @return A random number between 0 and \a range.
-    ///
-    /// @note This operator ignores any set minimum range parameter.
-    ///
-    inline long operator()(const u_long range) const 
-    { return gsl_rng_uniform_int(rng_->rng(), range); }
-
-    ///
-    /// @return A random number between \a min and \a range - \a min
-    ///
-    inline long operator()(const u_long range, const long min) const 
-    { return gsl_rng_uniform_int(rng_->rng(), range)+min; }
-
-
-  private:
-    long min_;
+    /// @param n sets the range. Object will generate integers from
+    /// [0,n-1].
+    ///
+    /// @todo exception should be thrown, when n is out of range
+    ///
+    DiscreteUniform(const u_long n);
+      
+    ///
+    /// This function returns a random integer from 0 to n-1
+    /// inclusive. All integers in the range [0,n-1] are equally
+    /// likely. n is set in constructor.
+    ///
+    inline u_long operator()(void) const 
+    { return gsl_rng_uniform_int(rng_->rng(), range_); }
+
+    ///
+    /// This function returns a random integer from 0 to n-1
+    /// inclusive. All integers in the range [0,n-1] are equally
+    /// likely.
+    ///
+    /// @todo exception should be thrown, when n is out of range
+    ///
+    inline u_long operator()(const u_long n) const 
+    { return gsl_rng_uniform_int(rng_->rng(), n); }
+
+
+  private:
     u_long range_;
   };
@@ -347 +340 @@
     /// @return A Poisson distributed number.
     ///
-    inline long operator()(void) const 
+    inline u_long operator()(void) const 
     { return gsl_ran_poisson(rng_->rng(), m_); }
 
@@ -387 +380 @@
     /// @return A random number.
     ///
-    inline long operator()(void) const 
+    inline u_long operator()(void) const 
     { return gsl_ran_discrete(rng_->rng(), gen_); }