lemon/random.h
changeset 49 9a556af88710
parent 39 0a01d811071f
child 62 4790635473ef
     1.1 --- a/lemon/random.h	Mon Jan 07 19:44:18 2008 +0100
     1.2 +++ b/lemon/random.h	Tue Jan 08 02:53:42 2008 +0100
     1.3 @@ -510,7 +510,7 @@
     1.4    /// bool h = rnd.boolean(0.8);            // P(h = true) = 0.8
     1.5    ///\endcode
     1.6    ///
     1.7 -  /// The lemon provides a global instance of the random number
     1.8 +  /// LEMON provides a global instance of the random number
     1.9    /// generator which name is \ref lemon::rnd "rnd". Usually it is a
    1.10    /// good programming convenience to use this global generator to get
    1.11    /// random numbers.
    1.12 @@ -526,12 +526,12 @@
    1.13  
    1.14    public:
    1.15  
    1.16 -    /// \brief Constructor
    1.17 +    /// \brief Default constructor
    1.18      ///
    1.19      /// Constructor with constant seeding.
    1.20      Random() { core.initState(); }
    1.21  
    1.22 -    /// \brief Constructor
    1.23 +    /// \brief Constructor with seed
    1.24      ///
    1.25      /// Constructor with seed. The current number type will be converted
    1.26      /// to the architecture word type.
    1.27 @@ -540,7 +540,7 @@
    1.28        _random_bits::Initializer<Number, Word>::init(core, seed);
    1.29      }
    1.30  
    1.31 -    /// \brief Constructor
    1.32 +    /// \brief Constructor with array seeding
    1.33      ///
    1.34      /// Constructor with array seeding. The given range should contain
    1.35      /// any number type and the numbers will be converted to the
    1.36 @@ -577,7 +577,7 @@
    1.37      /// \brief Returns a random real number from the range [0, 1)
    1.38      ///
    1.39      /// It returns a random real number from the range [0, 1). The
    1.40 -    /// default Number type is double.
    1.41 +    /// default Number type is \c double.
    1.42      template <typename Number>
    1.43      Number real() {
    1.44        return _random_bits::RealConversion<Number, Word>::convert(core);
    1.45 @@ -653,8 +653,8 @@
    1.46      /// \brief Returns a random non-negative integer
    1.47      ///
    1.48      /// It returns a random non-negative integer uniformly from the
    1.49 -    /// whole range of the current \c Number type.  The default result
    1.50 -    /// type of this function is unsigned int.
    1.51 +    /// whole range of the current \c Number type. The default result
    1.52 +    /// type of this function is <tt>unsigned int</tt>.
    1.53      template <typename Number>
    1.54      Number uinteger() {
    1.55        return _random_bits::IntConversion<Number, Word>::convert(core);
    1.56 @@ -668,7 +668,7 @@
    1.57      ///
    1.58      /// It returns a random integer uniformly from the whole range of
    1.59      /// the current \c Number type. The default result type of this
    1.60 -    /// function is int.
    1.61 +    /// function is \c int.
    1.62      template <typename Number>
    1.63      Number integer() {
    1.64        static const int nb = std::numeric_limits<Number>::digits + 
    1.65 @@ -689,7 +689,7 @@
    1.66        return bool_producer.convert(core);
    1.67      }
    1.68  
    1.69 -    ///\name Nonuniform distributions
    1.70 +    ///\name Non-uniform distributions
    1.71      ///
    1.72      
    1.73      ///@{