Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template variate_generator

boost::variate_generator

Synopsis

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

template<typename Engine, typename Distribution> 
class variate_generator {
public:
  // types
  typedef    ;
  typedef Engine                    ;      
  typedef Distribution              ;
  typedef  ;      

  // construct/copy/destruct
  (Engine, Distribution);

  // public member functions
   ();
  template<typename T>  (const T &);
   ();
  const  () ;
  distribution_type & ();
  const distribution_type & () ;
   () ;
   () ;
};

Description

A random variate generator is used to join a random number generator together with a random number distribution. Boost.Random provides a vast choice of generators as well as distributions .

The argument for the template parameter Engine shall be of the form U, U&, or U*, where U models a uniform random number generator . Then, the member engine_value_type names U (not the pointer or reference to U).

Specializations of variate_generator satisfy the requirements of CopyConstructible. They also satisfy the requirements of Assignable unless the template parameter Engine is of the form U&.

The complexity of all functions specified in this section is constant. No function described in this section except the constructor throws an exception.

variate_generator public construct/copy/destruct

  1. (Engine e, Distribution d);

    Constructs a variate_generator object with the associated uniform random number generator eng and the associated random distribution d.

    Throws: If and what the copy constructor of Engine or Distribution throws.

variate_generator public member functions

  1.  ();

    Returns: distribution()(engine())

  2. template<typename T>  (const T & value);

    Returns: distribution()(engine(), value).

  3.  ();

    Returns: A reference to the associated uniform random number generator.

  4. const  () ;

    Returns: A reference to the associated uniform random number generator.

  5. distribution_type & ();

    Returns: A reference to the associated random distribution .

  6. const distribution_type & () ;

    Returns: A reference to the associated random distribution.

  7.  () ;

    Precondition: distribution().min() is well-formed

    Returns: distribution().min()

  8.  () ;

    Precondition: distribution().max() is well-formed

    Returns: distribution().max()


PrevUpHomeNext