Changes in lemon/random.h [352:0badf3bb38c2:351:2593e163e407] in lemon

File:

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

lemon/random.h

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