Changeset 340:0badf3bb38c2 in lemon-main

Timestamp:

10/28/08 14:47:57 (16 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Minor doc improvements

File:

• lemon/random.h (modified) (11 diffs)

lemon/random.h

@@ -541 +541 @@
     /// @{
 
-    ///\name Initialization
-    ///
-    /// @{
-
     /// \brief Default constructor
     ///
@@ -709 +705 @@
     }
 
-    /// @}
-
-    ///\name Uniform distributions
-    ///
-    /// @{
-
     /// \brief Returns a random real number from the range [0, 1)
     ///
@@ -771 +761 @@
       return _random_bits::IntConversion<Number, Word>::convert(core);
     }
-
-    /// @}
 
     unsigned int uinteger() {
@@ -807 +795 @@
     ///\name Non-uniform distributions
     ///
-
     ///@{
 
-    /// \brief Returns a random bool
+    /// \brief Returns a random bool with given probability of true result.
     ///
     /// It returns a random bool with given probability of true result.
@@ -817 +804 @@
     }
 
-    /// Standard Gauss distribution
-
-    /// Standard Gauss distribution.
+    /// Standard normal (Gauss) distribution
+
+    /// Standard normal (Gauss) distribution.
     /// \note The Cartesian form of the Box-Muller
     /// transformation is used to generate a random normal distribution.
@@ -832 +819 @@
       return std::sqrt(-2*std::log(S)/S)*V1;
     }
-    /// Gauss distribution with given mean and standard deviation
-
-    /// Gauss distribution with given mean and standard deviation.
+    /// Normal (Gauss) distribution with given mean and standard deviation
+
+    /// Normal (Gauss) distribution with given mean and standard deviation.
     /// \sa gauss()
     double gauss(double mean,double std_dev)
@@ -865 +852 @@
     /// lognormal().
     std::pair<double,double> lognormalParamsFromMD(double mean,
-                                                   double std_dev)
+                                                   double std_dev)
     {
       double fr=std_dev/mean;
@@ -873 +860 @@
     }
     /// Lognormal distribution with given mean and standard deviation
-    
+
     /// Lognormal distribution with given mean and standard deviation.
     ///
@@ -880 +867 @@
       return lognormal(lognormalParamsFromMD(mean,std_dev));
     }
-    
+
     /// Exponential distribution with given mean
 
@@ -984 +971 @@
     ///\name Two dimensional distributions
     ///
-
     ///@{
 
@@ -1001 +987 @@
       return dim2::Point<double>(V1,V2);
     }
-    /// A kind of two dimensional Gauss distribution
+    /// A kind of two dimensional normal (Gauss) distribution
 
     /// This function provides a turning symmetric two-dimensional distribution.