Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class rand48

boost::random::rand48

Synopsis

// In header: <boost/random/linear_congruential.hpp>


class rand48 {
public:
  // types
  typedef  ;

  // construct/copy/destruct
  ();
  ();
  template<typename SeedSeq> ();
  template<typename It> (, );

  // public static functions
   ();
   ();

  // public member functions
   ();
   ();
  template<typename It>  (, );
  template<typename SeedSeq>  ();
   ();
   ();
  template<typename Iter>  (, );

  // friend functions
  template<typename CharT, typename Traits> 
     
    (, rand48 &);
  template<typename CharT, typename Traits> 
     
    (, rand48 &);
   (rand48 &, rand48 &);
   (rand48 &, rand48 &);

  // public data members
  static  has_fixed_range;
};

Description

Class rand48 models a pseudo-random number generator . It uses the linear congruential algorithm with the parameters a = 0x5DEECE66D, c = 0xB, m = 2**48. It delivers identical results to the lrand48() function available on some systems (assuming lcong48 has not been called).

It is only available on systems where uint64_t is provided as an integral type, so that for example static in-class constants and/or enum definitions with large uint64_t numbers work.

rand48 public construct/copy/destruct

  1. ();

    Seeds the generator with the default seed.

  2. ( x0);

    Constructs a rand48 generator with x(0) := (x0 << 16) | 0x330e.

  3. template<typename SeedSeq> ( seq);

    Seeds the generator with values produced by seq.generate().

  4. template<typename It> ( first,  last);

    Seeds the generator using values from an iterator range, and updates first to point one past the last value consumed.

rand48 public static functions

  1.  ();

    Returns the smallest value that the generator can produce

  2.  ();

    Returns the largest value that the generator can produce

rand48 public member functions

  1.  ();

    Seeds the generator with the default seed.

  2.  ( x0);

    Changes the current value x(n) of the generator to (x0 << 16) | 0x330e.

  3. template<typename It>  ( first,  last);

    Seeds the generator using values from an iterator range, and updates first to point one past the last value consumed.

  4. template<typename SeedSeq>  ( seq);

    Seeds the generator with values produced by seq.generate().

  5.  ();

    Returns the next value of the generator.

  6.  ( z);

    Advances the state of the generator by z.

  7. template<typename Iter>  ( first,  last);

    Fills a range with random values

rand48 friend functions

  1. template<typename CharT, typename Traits> 
       
      ( os, rand48 & r);

    Writes a rand48 to a std::ostream.

  2. template<typename CharT, typename Traits> 
       
      ( is, rand48 & r);

    Reads a rand48 from a std::istream.

  3.  (rand48 & x, rand48 & y);

    Returns true if the two generators will produce identical sequences of values.

  4.  (rand48 & x, rand48 & y);

    Returns true if the two generators will produce different sequences of values.


PrevUpHomeNext