Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template negative_binomial_distribution

boost::random::negative_binomial_distribution

Synopsis

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

template<typename IntType, typename RealType> 
class negative_binomial_distribution {
public:
  // types
  typedef   ;
  typedef  ; 

  // member classes/structs/unions

  class param_type {
  public:
    // types
    typedef negative_binomial_distribution ;

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

    // public member functions
     () ;
     () ;

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

  // construct/copy/destruct
  ( = ,  = );
  (param_type &);

  // public member functions
  template<typename URNG>  () ;
  template<typename URNG>  (, param_type &) ;
   () ;
   () ;
   () ;
   () ;
  param_type () ;
   (param_type &);
   ();

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

Description

The negative binomial distribution is an integer valued distribution with two parameters, k and p. The distribution produces non-negative values.

The distribution function is .

This implementation uses a gamma-poisson mixture.

negative_binomial_distribution public construct/copy/destruct

  1. ( k = ,  p = );

    Construct a negative_binomial_distribution object. k and p are the parameters of the distribution.

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

  2. (param_type & param);

    Construct an negative_binomial_distribution object from the parameters.

negative_binomial_distribution public member functions

  1. template<typename URNG>  ( urng) ;

    Returns a random variate distributed according to the negative binomial distribution.

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

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

  3.  () ;

    Returns the k parameter of the distribution.

  4.  () ;

    Returns the p parameter of the distribution.

  5.  () ;

    Returns the smallest value that the distribution can produce.

  6.  () ;

    Returns the largest value that the distribution can produce.

  7. param_type () ;

    Returns the parameters of the distribution.

  8.  (param_type & param);

    Sets parameters of the distribution.

  9.  ();

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

negative_binomial_distribution friend functions

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

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

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

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

  3.  (negative_binomial_distribution & lhs, 
                    negative_binomial_distribution & rhs);

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

  4.  (negative_binomial_distribution & lhs, 
                    negative_binomial_distribution & rhs);

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


PrevUpHomeNext