lemon-1.2: comparison lemon/random.h

equal deleted inserted replaced

-:d76f570281fc
+:c481e6dbd91e
 /// int c = rnd.integer<int>();           // - 2^31 .. 2^31 - 1
 /// bool g = rnd.boolean();               // P(g = true) = 0.5
 /// bool h = rnd.boolean(0.8);            // P(h = true) = 0.8
 ///\endcode
 ///
-/// The lemon provides a global instance of the random number
+/// LEMON provides a global instance of the random number
 /// generator which name is \ref lemon::rnd "rnd". Usually it is a
 /// good programming convenience to use this global generator to get
 /// random numbers.
 class Random {
 private:
 _random_bits::BoolProducer<Word> bool_producer;
 public:
-/// \brief Constructor
+/// \brief Default constructor
 ///
 /// Constructor with constant seeding.
 Random() { core.initState(); }
-/// \brief Constructor
+/// \brief Constructor with seed
 ///
 /// Constructor with seed. The current number type will be converted
 /// to the architecture word type.
 template <typename Number>
 Random(Number seed) {
 _random_bits::Initializer<Number, Word>::init(core, seed);
 }
-/// \brief Constructor
+/// \brief Constructor with array seeding
 ///
 /// Constructor with array seeding. The given range should contain
 /// any number type and the numbers will be converted to the
 /// architecture word type.
 template <typename Iterator>
 }
 /// \brief Returns a random real number from the range [0, 1)
 ///
 /// It returns a random real number from the range [0, 1). The
-/// default Number type is double.
+/// default Number type is \c double.
 template <typename Number>
 Number real() {
 return _random_bits::RealConversion<Number, Word>::convert(core);
 }
 }
 /// \brief Returns a random non-negative integer
 ///
 /// It returns a random non-negative integer uniformly from the
-/// whole range of the current \c Number type.  The default result
+/// whole range of the current \c Number type. The default result
-/// type of this function is unsigned int.
+/// type of this function is <tt>unsigned int</tt>.
 template <typename Number>
 Number uinteger() {
 return _random_bits::IntConversion<Number, Word>::convert(core);
 }
 /// \brief Returns a random integer
 ///
 /// It returns a random integer uniformly from the whole range of
 /// the current \c Number type. The default result type of this
-/// function is int.
+/// function is \c int.
 template <typename Number>
 Number integer() {
 static const int nb = std::numeric_limits<Number>::digits +
 (std::numeric_limits<Number>::is_signed ? 1 : 0);
 return _random_bits::IntConversion<Number, Word, nb>::convert(core);
 /// a new random word and fill the buffer up.
 bool boolean() {
 return bool_producer.convert(core);
 }
-///\name Nonuniform distributions
+///\name Non-uniform distributions
 ///
 ///@{
 /// \brief Returns a random bool

changeset 53	afb5325d6211
parent 39	0a01d811071f
child 62	4790635473ef