Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Public Types | Public Member Functions | Friends | List of all members
boost::random::negative_binomial_distribution< IntType, RealType > Class Template Reference

The negative binomial distribution is an integer valued distribution with two parameters, k and p. More...

#include <negative_binomial_distribution.hpp>

Classes

class  param_type
 

Public Types

typedef IntType result_type
 
typedef RealType input_type
 

Public Member Functions

 negative_binomial_distribution (IntType k_arg=1, RealType p_arg=RealType(0.5))
 Construct a negative_binomial_distribution object. More...
 
 negative_binomial_distribution (const param_type &parm)
 Construct an negative_binomial_distribution object from the parameters. More...
 
template<class URNG >
IntType operator() (URNG &urng) const
 Returns a random variate distributed according to the negative binomial distribution. More...
 
template<class URNG >
IntType operator() (URNG &urng, const param_type &parm) const
 Returns a random variate distributed according to the negative binomial distribution with parameters specified by param. More...
 
IntType k () const
 Returns the k parameter of the distribution. More...
 
RealType p () const
 Returns the p parameter of the distribution. More...
 
IntType min BOOST_PREVENT_MACRO_SUBSTITUTION () const
 Returns the smallest value that the distribution can produce. More...
 
IntType max BOOST_PREVENT_MACRO_SUBSTITUTION () const
 Returns the largest value that the distribution can produce. More...
 
param_type param () const
 Returns the parameters of the distribution. More...
 
void param (const param_type &parm)
 Sets parameters of the distribution. More...
 
void reset ()
 Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. More...
 

Friends

template<class CharT , class Traits >
std::basic_ostream< CharT,
Traits > & 		operator<< (std::basic_ostream< CharT, Traits > &os, const negative_binomial_distribution &bd)
 Writes the parameters of the distribution to a std::ostream. More...
 
template<class CharT , class Traits >
std::basic_istream< CharT,
Traits > & 		operator>> (std::basic_istream< CharT, Traits > &is, negative_binomial_distribution &bd)
 Reads the parameters of the distribution from a std::istream. More...
 
bool operator== (const negative_binomial_distribution &lhs, const negative_binomial_distribution &rhs)
 Returns true if the two distributions will produce the same sequence of values, given equal generators. More...
 
bool operator!= (const negative_binomial_distribution &lhs, const negative_binomial_distribution &rhs)
 Returns true if the two distributions could produce different sequences of values, given equal generators. More...
 

Detailed Description

template<class IntType = int, class RealType = double>
class boost::random::negative_binomial_distribution< IntType, RealType >

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 $\displaystyle P(i) = {k+i-1\choose i}p^k(1-p)^i$.

This implementation uses a gamma-poisson mixture.

Member Typedef Documentation

template<class IntType = int, class RealType = double>
typedef RealType boost::random::negative_binomial_distribution< IntType, RealType >::input_type
template<class IntType = int, class RealType = double>
typedef IntType boost::random::negative_binomial_distribution< IntType, RealType >::result_type

Constructor & Destructor Documentation

template<class IntType = int, class RealType = double>
boost::random::negative_binomial_distribution< IntType, RealType >::negative_binomial_distribution ( IntType  k_arg = 1,
RealType  p_arg = RealType(0.5) 
)
inlineexplicit

Construct a negative_binomial_distribution object.

k and p are the parameters of the distribution.

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

Referenced by boost::random::negative_binomial_distribution< IntType, RealType >::operator()().

template<class IntType = int, class RealType = double>
boost::random::negative_binomial_distribution< IntType, RealType >::negative_binomial_distribution ( const param_type &  parm)
inlineexplicit

Construct an negative_binomial_distribution object from the parameters.

Member Function Documentation

template<class IntType = int, class RealType = double>
IntType min boost::random::negative_binomial_distribution< IntType, RealType >::BOOST_PREVENT_MACRO_SUBSTITUTION ( ) const
inline

Returns the smallest value that the distribution can produce.

template<class IntType = int, class RealType = double>
IntType max boost::random::negative_binomial_distribution< IntType, RealType >::BOOST_PREVENT_MACRO_SUBSTITUTION ( ) const
inline

Returns the largest value that the distribution can produce.

References boost::accumulators::extract::max.

template<class IntType = int, class RealType = double>
IntType boost::random::negative_binomial_distribution< IntType, RealType >::k ( ) const
inline

Returns the k parameter of the distribution.

References boost::phoenix::local_names::_k.

template<class IntType = int, class RealType = double>
template<class URNG >
IntType boost::random::negative_binomial_distribution< IntType, RealType >::operator() ( URNG &  urng) const
inline

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

References boost::phoenix::local_names::_k, and boost::phoenix::local_names::_p.

template<class IntType = int, class RealType = double>
template<class URNG >
IntType boost::random::negative_binomial_distribution< IntType, RealType >::operator() ( URNG &  urng,
const param_type &  parm 
) const
inline

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

References boost::random::negative_binomial_distribution< IntType, RealType >::negative_binomial_distribution().

template<class IntType = int, class RealType = double>
RealType boost::random::negative_binomial_distribution< IntType, RealType >::p ( ) const
inline

Returns the p parameter of the distribution.

References boost::phoenix::local_names::_p.

template<class IntType = int, class RealType = double>
param_type boost::random::negative_binomial_distribution< IntType, RealType >::param ( ) const
inline

Returns the parameters of the distribution.

References boost::phoenix::local_names::_k, and boost::phoenix::local_names::_p.

template<class IntType = int, class RealType = double>
void boost::random::negative_binomial_distribution< IntType, RealType >::param ( const param_type &  parm)
inline

Sets parameters of the distribution.

References boost::phoenix::local_names::_k, boost::phoenix::local_names::_p, boost::random::negative_binomial_distribution< IntType, RealType >::param_type::k(), and boost::random::negative_binomial_distribution< IntType, RealType >::param_type::p().

template<class IntType = int, class RealType = double>
void boost::random::negative_binomial_distribution< IntType, RealType >::reset ( void  )
inline

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

Friends And Related Function Documentation

template<class IntType = int, class RealType = double>
bool operator!= ( const negative_binomial_distribution< IntType, RealType > &  lhs,
const negative_binomial_distribution< IntType, RealType > &  rhs 
)
friend

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

template<class IntType = int, class RealType = double>
template<class CharT , class Traits >
std::basic_ostream<CharT,Traits>& operator<< ( std::basic_ostream< CharT, Traits > &  os,
const negative_binomial_distribution< IntType, RealType > &  bd 
)
friend

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

template<class IntType = int, class RealType = double>
bool operator== ( const negative_binomial_distribution< IntType, RealType > &  lhs,
const negative_binomial_distribution< IntType, RealType > &  rhs 
)
friend

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

template<class IntType = int, class RealType = double>
template<class CharT , class Traits >
std::basic_istream<CharT,Traits>& operator>> ( std::basic_istream< CharT, Traits > &  is,
negative_binomial_distribution< IntType, RealType > &  bd 
)
friend

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

The documentation for this class was generated from the following file: