Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template discard_block_engine

boost::random::discard_block_engine

Synopsis

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

template<typename UniformRandomNumberGenerator,  p,  r> 
class discard_block_engine {
public:
  // types
  typedef  ;  
  typedef        ;

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

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

  // public static functions
   ();
   ();

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

  // public data members
  static  block_size;
  static  used_block;
  static  has_fixed_range;
  static  total_block;
  static  returned_block;
};

Description

The class template discard_block_engine is a model of pseudo-random number generator . It modifies another generator by discarding parts of its output. Out of every block of p results, the first r will be returned and the rest discarded.

Requires: 0 < p <= r

discard_block_engine public construct/copy/destruct

  1. ();

    Uses the default seed for the base generator.

  2. ( rng);

    Constructs a new discard_block_engine with a copy of rng.

  3. ( rng);

    Constructs a new discard_block_engine with rng.

  4. ( value);

    Creates a new discard_block_engine and seeds the underlying generator with value

  5. template<typename SeedSeq> ( seq);

    Creates a new discard_block_engine and seeds the underlying generator with seq

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

    Creates a new discard_block_engine and seeds the underlying generator with first and last.

discard_block_engine public member functions

  1.  ();

    default seeds the underlying generator.

  2.  ( s);

    Seeds the underlying generator with s.

  3. template<typename SeedSeq>  ( seq);

    Seeds the underlying generator with seq.

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

    Seeds the underlying generator with first and last.

  5.  () ;

    Returns the underlying engine.

  6.  ();

    Returns the next value of the generator.

  7.  ( z);
  8. template<typename It>  ( first,  last);

discard_block_engine public static functions

  1.  ();

    Returns the smallest value that the generator can produce. This is the same as the minimum of the underlying generator.

  2.  ();

    Returns the largest value that the generator can produce. This is the same as the maximum of the underlying generator.

discard_block_engine friend functions

  1. template<typename CharT, typename Traits> 
       
      ( os, 
                 discard_block_engine & s);

    Writes a discard_block_engine to a std::ostream.

  2. template<typename CharT, typename Traits> 
       
      ( is, 
                 discard_block_engine & s);

    Reads a discard_block_engine from a std::istream.

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

    Returns true if the two generators will produce identical sequences.

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

    Returns true if the two generators will produce different sequences.


PrevUpHomeNext