COIN-OR::LEMON - Graph Library

Changeset 340:0badf3bb38c2 in lemon-1.2 for lemon


Ignore:
Timestamp:
10/28/08 14:47:57 (11 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Phase:
public
Message:

Minor doc improvements

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/random.h

    r339 r340  
    541541    /// @{
    542542
    543     ///\name Initialization
    544     ///
    545     /// @{
    546 
    547543    /// \brief Default constructor
    548544    ///
     
    709705    }
    710706
    711     /// @}
    712 
    713     ///\name Uniform distributions
    714     ///
    715     /// @{
    716 
    717707    /// \brief Returns a random real number from the range [0, 1)
    718708    ///
     
    771761      return _random_bits::IntConversion<Number, Word>::convert(core);
    772762    }
    773 
    774     /// @}
    775763
    776764    unsigned int uinteger() {
     
    807795    ///\name Non-uniform distributions
    808796    ///
    809 
    810797    ///@{
    811798
    812     /// \brief Returns a random bool
     799    /// \brief Returns a random bool with given probability of true result.
    813800    ///
    814801    /// It returns a random bool with given probability of true result.
     
    817804    }
    818805
    819     /// Standard Gauss distribution
    820 
    821     /// Standard Gauss distribution.
     806    /// Standard normal (Gauss) distribution
     807
     808    /// Standard normal (Gauss) distribution.
    822809    /// \note The Cartesian form of the Box-Muller
    823810    /// transformation is used to generate a random normal distribution.
     
    832819      return std::sqrt(-2*std::log(S)/S)*V1;
    833820    }
    834     /// Gauss distribution with given mean and standard deviation
    835 
    836     /// Gauss distribution with given mean and standard deviation.
     821    /// Normal (Gauss) distribution with given mean and standard deviation
     822
     823    /// Normal (Gauss) distribution with given mean and standard deviation.
    837824    /// \sa gauss()
    838825    double gauss(double mean,double std_dev)
     
    865852    /// lognormal().
    866853    std::pair<double,double> lognormalParamsFromMD(double mean,
    867                                                    double std_dev)
     854                                                   double std_dev)
    868855    {
    869856      double fr=std_dev/mean;
     
    873860    }
    874861    /// Lognormal distribution with given mean and standard deviation
    875    
     862
    876863    /// Lognormal distribution with given mean and standard deviation.
    877864    ///
     
    880867      return lognormal(lognormalParamsFromMD(mean,std_dev));
    881868    }
    882    
     869
    883870    /// Exponential distribution with given mean
    884871
     
    984971    ///\name Two dimensional distributions
    985972    ///
    986 
    987973    ///@{
    988974
     
    1001987      return dim2::Point<double>(V1,V2);
    1002988    }
    1003     /// A kind of two dimensional Gauss distribution
     989    /// A kind of two dimensional normal (Gauss) distribution
    1004990
    1005991    /// This function provides a turning symmetric two-dimensional distribution.
Note: See TracChangeset for help on using the changeset viewer.