Changeset 366 for trunk/lib/random/Random.h

Timestamp:

Aug 5, 2005, 10:58:56 AM (18 years ago)

Author:

Peter

Message:

moved namespace random to its own directory

File:

• trunk/lib/random/Random.h (moved) (moved from trunk/lib/utility/Random.h) (3 diffs)

trunk/lib/random/Random.h

@@ -39 +39 @@
 
 
+  ///
+  /// @brief continuous random distributions.
+  /// Base for continuous random distributions.
+  ///
   class RandomContinuous
   {
   public:
 
+    ///
+    /// @brief Constructor
+    ///
     inline RandomContinuous(void) { rng_=RNG::instance(89); }
 
@@ -52 +59 @@
 
 
-
+  ///
+  /// @brief Uniform distribution
+  ///
+  /// Class for generating a random number from a flat distribution
+  /// between zero and unity.
+  ///
+  /// Distribution function \f$ f(x) = 1 \f$ for \f$ 0 \le x < 1 \f$
+  /// Expectation value: 0.5
+  /// Variance: \f$ \frac{1}{12} \f$
+  ///
   class RandomContinuousUniform : public RandomContinuous
   {
@@ -114 +130 @@
 
   ///
-  /// Base class for discrete random distributions.
+  /// @brief discrete random distributions.
+  /// Base for discrete random distributions.
   ///
   class RandomDiscrete