Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template binomial_distribution

boost::random::binomial_distribution

Synopsis

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

template<typename IntType = int, typename RealType = double> 
class binomial_distribution {
public:
  // types
  typedef IntType  ;
  typedef RealType ; 

  // member classes/structs/unions

  class param_type {
  public:
    // types
    typedef binomial_distribution ;

    // construct/copy/destruct
    (IntType = , RealType = );

    // public member functions
    IntType () ;
    RealType () ;

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

  // construct/copy/destruct
  (IntType = , RealType = );
  (const param_type &);

  // public member functions
  template<typename URNG> IntType (URNG &) ;
  template<typename URNG> IntType (URNG &, const param_type &) ;
  IntType () ;
  RealType () ;
  IntType () ;
  IntType () ;
  param_type () ;
  void (const param_type &);
  void ();

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

Description

The binomial distribution is an integer valued distribution with two parameters, t and p. The values of the distribution are within the range [0,t].

The distribution function is .

The algorithm used is the BTRD algorithm described in

"The generation of binomial random variates", Wolfgang Hormann, Journal of Statistical Computation and Simulation, Volume 46, Issue 1 & 2 April 1993 , pages 101 - 110

binomial_distribution public construct/copy/destruct

  1. (IntType t = , RealType p = );

    Construct a binomial_distribution object. t and p are the parameters of the distribution.

    Requires: t >=0 && 0 <= p <= 1

  2. (const param_type & param);

    Construct an binomial_distribution object from the parameters.

binomial_distribution public member functions

  1. template<typename URNG> IntType (URNG & urng) ;

    Returns a random variate distributed according to the binomial distribution.

  2. template<typename URNG> 
      IntType (URNG & urng, const param_type & param) ;

    Returns a random variate distributed according to the binomial distribution with parameters specified by param.

  3. IntType () ;

    Returns the t parameter of the distribution.

  4. RealType () ;

    Returns the p parameter of the distribution.

  5. IntType () ;

    Returns the smallest value that the distribution can produce.

  6. IntType () ;

    Returns the largest value that the distribution can produce.

  7. param_type () ;

    Returns the parameters of the distribution.

  8. void (const param_type & param);

    Sets parameters of the distribution.

  9. void ();

    Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset.

binomial_distribution friend functions

  1. template<typename CharT, typename Traits> 
      CharT, Traits > & 
      (CharT, Traits > & os, 
                 const binomial_distribution & bd);

    Writes the parameters of the distribution to a std::ostream.

  2. template<typename CharT, typename Traits> 
      CharT, Traits > & 
      (CharT, Traits > & is, 
                 binomial_distribution & bd);

    Reads the parameters of the distribution from a std::istream.

  3. bool (const binomial_distribution & lhs, 
                    const binomial_distribution & rhs);

    Returns true if the two distributions will produce the same sequence of values, given equal generators.

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

    Returns true if the two distributions could produce different sequences of values, given equal generators.


PrevUpHomeNext