Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template linear_feedback_shift_engine

boost::random::linear_feedback_shift_engine

Synopsis

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

template<typename UIntType,  w,  k,  q,  s> 
class linear_feedback_shift_engine {
public:
  // types
  typedef UIntType ;

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

  // public static functions
  constexpr result_type ();
  constexpr result_type ();

  // public member functions
  void ();
  void (UIntType);
  template<typename SeedSeq> void (SeedSeq &);
  template<typename It> void (It &, It);
  result_type ();
  template<typename Iter> void (Iter, Iter);
  void (boost::uintmax_t);

  // friend functions
  template<typename CharT, typename Traits> 
    CharT, Traits > & 
    (CharT, Traits > &, 
               const linear_feedback_shift_engine &);
  template<typename CharT, typename Traits> 
    CharT, Traits > & 
    (CharT, Traits > &, 
               const linear_feedback_shift_engine &);
  bool (const linear_feedback_shift_engine &, 
                  const linear_feedback_shift_engine &);
  bool (const linear_feedback_shift_engine &, 
                  const linear_feedback_shift_engine &);

  // public data members
  static const bool has_fixed_range;
  static const int word_size;
  static const int exponent1;
  static const int exponent2;
  static const int step_size;
  static const UIntType default_seed;
};

Description

Instatiations of linear_feedback_shift model a pseudo-random number generator . It was originally proposed in

"Random numbers generated by linear recurrence modulo two.", Tausworthe, R. C.(1965), Mathematics of Computation 19, 201-209.

linear_feedback_shift_engine public construct/copy/destruct

  1. ();

    Constructs a linear_feedback_shift_engine, using the default seed.

  2. (UIntType s0);

    Constructs a linear_feedback_shift_engine, seeding it with s0.

  3. template<typename SeedSeq> 
      (SeedSeq & seq);

    Constructs a linear_feedback_shift_engine, seeding it with seq.

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

    Constructs a linear_feedback_shift_engine, seeding it with values from the range [first, last).

linear_feedback_shift_engine public static functions

  1. constexpr result_type ();

    Returns the smallest value that the generator can produce.

  2. constexpr result_type ();

    Returns the largest value that the generator can produce.

linear_feedback_shift_engine public member functions

  1. void ();

    Seeds a linear_feedback_shift_engine with the default seed.

  2. void (UIntType s0);

    Seeds a linear_feedback_shift_engine with s0.

  3. template<typename SeedSeq> void (SeedSeq & seq);

    Seeds a linear_feedback_shift_engine with values produced by seq.generate().

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

    Seeds a linear_feedback_shift_engine with values from the range [first, last).

  5. result_type ();

    Returns the next value of the generator.

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

    Fills a range with random values

  7. void (boost::uintmax_t z);

    Advances the state of the generator by z.

linear_feedback_shift_engine friend functions

  1. template<typename CharT, typename Traits> 
      CharT, Traits > & 
      (CharT, Traits > & os, 
                 const linear_feedback_shift_engine & x);

    Writes the textual representation of the generator to a std::ostream.

  2. template<typename CharT, typename Traits> 
      CharT, Traits > & 
      (CharT, Traits > & is, 
                 const linear_feedback_shift_engine & x);

    Reads the textual representation of the generator from a std::istream.

  3. bool (const linear_feedback_shift_engine & x, 
                    const linear_feedback_shift_engine & y);

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

  4. bool (const linear_feedback_shift_engine & lhs, 
                    const linear_feedback_shift_engine & rhs);

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


PrevUpHomeNext