.TH "std::binomial_distribution< _IntType >" 3cxx "libstdc++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
std::binomial_distribution< _IntType > \- A discrete binomial random number distribution\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <random\&.h>\fP
.SS "Classes"

.in +1c
.ti -1c
.RI "struct \fBparam_type\fP"
.br
.in -1c
.SS "Public Types"

.in +1c
.ti -1c
.RI "\fBtypedef\fP _IntType \fBresult_type\fP"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBbinomial_distribution\fP (_IntType __t, double __p=0\&.5)"
.br
.ti -1c
.RI "\fBbinomial_distribution\fP (\fBconst\fP \fBparam_type\fP &__p)"
.br
.ti -1c
.RI "template<\fBtypename\fP \fB_ForwardIterator\fP , \fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBvoid\fP \fB__generate\fP (\fB_ForwardIterator\fP __f, \fB_ForwardIterator\fP __t, \fB_UniformRandomNumberGenerator\fP &\fB__urng\fP)"
.br
.ti -1c
.RI "template<\fBtypename\fP \fB_ForwardIterator\fP , \fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBvoid\fP \fB__generate\fP (\fB_ForwardIterator\fP __f, \fB_ForwardIterator\fP __t, \fB_UniformRandomNumberGenerator\fP &\fB__urng\fP, \fBconst\fP \fBparam_type\fP &__p)"
.br
.ti -1c
.RI "template<\fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBvoid\fP \fB__generate\fP (\fBresult_type\fP *__f, \fBresult_type\fP *__t, \fB_UniformRandomNumberGenerator\fP &\fB__urng\fP, \fBconst\fP \fBparam_type\fP &__p)"
.br
.ti -1c
.RI "\fBresult_type\fP \fBmax\fP () \fBconst\fP"
.br
.RI "Returns the least upper bound value of the distribution\&. "
.ti -1c
.RI "\fBresult_type\fP \fBmin\fP () \fBconst\fP"
.br
.RI "Returns the greatest lower bound value of the distribution\&. "
.ti -1c
.RI "template<\fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBresult_type\fP \fBoperator()\fP (\fB_UniformRandomNumberGenerator\fP &\fB__urng\fP)"
.br
.RI "Generating functions\&. "
.ti -1c
.RI "template<\fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBresult_type\fP \fBoperator()\fP (\fB_UniformRandomNumberGenerator\fP &\fB__urng\fP, \fBconst\fP \fBparam_type\fP &__p)"
.br
.ti -1c
.RI "double \fBp\fP () \fBconst\fP"
.br
.RI "Returns the distribution \fCp\fP parameter\&. "
.ti -1c
.RI "\fBparam_type\fP \fBparam\fP () \fBconst\fP"
.br
.RI "Returns the parameter set of the distribution\&. "
.ti -1c
.RI "\fBvoid\fP \fBparam\fP (\fBconst\fP \fBparam_type\fP &\fB__param\fP)"
.br
.RI "Sets the parameter set of the distribution\&. "
.ti -1c
.RI "\fBvoid\fP \fBreset\fP ()"
.br
.RI "Resets the distribution state\&. "
.ti -1c
.RI "_IntType \fBt\fP () \fBconst\fP"
.br
.RI "Returns the distribution \fCt\fP parameter\&. "
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "template<\fBtypename\fP \fB_IntType1\fP , \fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstd::basic_ostream\fP< _CharT, _Traits > & \fBoperator<<\fP (\fBstd::basic_ostream\fP< _CharT, _Traits > &\fB__os\fP, \fBconst\fP \fBstd::binomial_distribution\fP< \fB_IntType1\fP > &__x)"
.br
.RI "Inserts a binomial_distribution random number distribution \fC__x\fP into the output stream \fC__os\fP\&. "
.ti -1c
.RI "bool \fBoperator==\fP (\fBconst\fP \fBbinomial_distribution\fP &__d1, \fBconst\fP \fBbinomial_distribution\fP &\fB__d2\fP)"
.br
.RI "Return true if two binomial distributions have the same parameters and the sequences that would be generated are equal\&. "
.ti -1c
.RI "template<\fBtypename\fP \fB_IntType1\fP , \fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstd::basic_istream\fP< _CharT, _Traits > & \fBoperator>>\fP (\fBstd::basic_istream\fP< _CharT, _Traits > &\fB__is\fP, \fBstd::binomial_distribution\fP< \fB_IntType1\fP > &__x)"
.br
.RI "Extracts a binomial_distribution random number distribution \fC__x\fP from the input stream \fC__is\fP\&. "
.in -1c
.SH "Detailed Description"
.PP 

.SS "template<\fBtypename\fP _IntType = int>
.br
class std::binomial_distribution< _IntType >"A discrete binomial random number distribution\&. 

The formula for the binomial probability density function is $p(i|t,p) = \binom{t}{i} p^i (1 - p)^{t - i}$ where $t$ and $p$ are the parameters of the distribution\&. 
.PP
Definition at line \fB3732\fP of file \fBrandom\&.h\fP\&.
.SH "Member Typedef Documentation"
.PP 
.SS "template<\fBtypename\fP _IntType  = int> \fBtypedef\fP _IntType \fBstd::binomial_distribution\fP< _IntType >::result_type"
The type of the range of the distribution\&. 
.PP
Definition at line \fB3739\fP of file \fBrandom\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "template<\fBtypename\fP _IntType  = int> \fBstd::binomial_distribution\fP< _IntType >::binomial_distribution ()\fC [inline]\fP"

.PP
Definition at line \fB3792\fP of file \fBrandom\&.h\fP\&.
.SS "template<\fBtypename\fP _IntType  = int> \fBstd::binomial_distribution\fP< _IntType >::binomial_distribution (_IntType __t, double __p = \fC0\&.5\fP)\fC [inline]\fP, \fC [explicit]\fP"

.PP
Definition at line \fB3795\fP of file \fBrandom\&.h\fP\&.
.SS "template<\fBtypename\fP _IntType  = int> \fBstd::binomial_distribution\fP< _IntType >::binomial_distribution (\fBconst\fP \fBparam_type\fP & __p)\fC [inline]\fP, \fC [explicit]\fP"

.PP
Definition at line \fB3800\fP of file \fBrandom\&.h\fP\&.
.SH "Member Function Documentation"
.PP 
.SS "template<\fBtypename\fP _IntType  = int> template<\fBtypename\fP \fB_ForwardIterator\fP , \fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBvoid\fP \fBstd::binomial_distribution\fP< _IntType >::__generate (\fB_ForwardIterator\fP __f, \fB_ForwardIterator\fP __t, \fB_UniformRandomNumberGenerator\fP & __urng)\fC [inline]\fP"

.PP
Definition at line \fB3870\fP of file \fBrandom\&.h\fP\&.
.SS "template<\fBtypename\fP _IntType  = int> template<\fBtypename\fP \fB_ForwardIterator\fP , \fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBvoid\fP \fBstd::binomial_distribution\fP< _IntType >::__generate (\fB_ForwardIterator\fP __f, \fB_ForwardIterator\fP __t, \fB_UniformRandomNumberGenerator\fP & __urng, \fBconst\fP \fBparam_type\fP & __p)\fC [inline]\fP"

.PP
Definition at line \fB3877\fP of file \fBrandom\&.h\fP\&.
.SS "template<\fBtypename\fP _IntType  = int> template<\fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBvoid\fP \fBstd::binomial_distribution\fP< _IntType >::__generate (\fBresult_type\fP * __f, \fBresult_type\fP * __t, \fB_UniformRandomNumberGenerator\fP & __urng, \fBconst\fP \fBparam_type\fP & __p)\fC [inline]\fP"

.PP
Definition at line \fB3884\fP of file \fBrandom\&.h\fP\&.
.SS "template<\fBtypename\fP _IntType  = int> \fBresult_type\fP \fBstd::binomial_distribution\fP< _IntType >::max () const\fC [inline]\fP"

.PP
Returns the least upper bound value of the distribution\&. 
.PP
Definition at line \fB3851\fP of file \fBrandom\&.h\fP\&.
.SS "template<\fBtypename\fP _IntType  = int> \fBresult_type\fP \fBstd::binomial_distribution\fP< _IntType >::min () const\fC [inline]\fP"

.PP
Returns the greatest lower bound value of the distribution\&. 
.PP
Definition at line \fB3844\fP of file \fBrandom\&.h\fP\&.
.SS "template<\fBtypename\fP _IntType  = int> template<\fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBresult_type\fP \fBstd::binomial_distribution\fP< _IntType >::operator() (\fB_UniformRandomNumberGenerator\fP & __urng)\fC [inline]\fP"

.PP
Generating functions\&. 
.PP
Definition at line \fB3859\fP of file \fBrandom\&.h\fP\&.
.PP
References \fBstd::binomial_distribution< _IntType >::operator()()\fP\&.
.PP
Referenced by \fBstd::binomial_distribution< _IntType >::operator()()\fP\&.
.SS "template<\fBtypename\fP _IntType > template<\fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBbinomial_distribution\fP< _IntType >\fB::result_type\fP \fBstd::binomial_distribution\fP< _IntType >::operator() (\fB_UniformRandomNumberGenerator\fP & __urng, \fBconst\fP \fBparam_type\fP & __param)"
A rejection algorithm when t * p >= 8 and a simple waiting time method - the second in the referenced book - otherwise\&. NB: The former is available only if _GLIBCXX_USE_C99_MATH_TR1 is defined\&.
.PP
Reference: Devroye, L\&. Non-Uniform Random Variates Generation\&. Springer-Verlag, New York, 1986, Ch\&. X, Sect\&. 4 (+ Errata!)\&. 
.PP
Definition at line \fB1539\fP of file \fBbits/random\&.tcc\fP\&.
.PP
References \fBstd::abs()\fP, \fBstd::numeric_limits< _Tp >::epsilon()\fP, \fBstd::log()\fP, and \fBstd::numeric_limits< _Tp >::max()\fP\&.
.SS "template<\fBtypename\fP _IntType  = int> double \fBstd::binomial_distribution\fP< _IntType >::p () const\fC [inline]\fP"

.PP
Returns the distribution \fCp\fP parameter\&. 
.PP
Definition at line \fB3822\fP of file \fBrandom\&.h\fP\&.
.SS "template<\fBtypename\fP _IntType  = int> \fBparam_type\fP \fBstd::binomial_distribution\fP< _IntType >::param () const\fC [inline]\fP"

.PP
Returns the parameter set of the distribution\&. 
.PP
Definition at line \fB3829\fP of file \fBrandom\&.h\fP\&.
.SS "template<\fBtypename\fP _IntType  = int> \fBvoid\fP \fBstd::binomial_distribution\fP< _IntType >::param (\fBconst\fP \fBparam_type\fP & __param)\fC [inline]\fP"

.PP
Sets the parameter set of the distribution\&. 
.PP
\fBParameters\fP
.RS 4
\fI__param\fP The new parameter set of the distribution\&. 
.RE
.PP

.PP
Definition at line \fB3837\fP of file \fBrandom\&.h\fP\&.
.SS "template<\fBtypename\fP _IntType  = int> \fBvoid\fP \fBstd::binomial_distribution\fP< _IntType >::reset ()\fC [inline]\fP"

.PP
Resets the distribution state\&. 
.PP
Definition at line \fB3808\fP of file \fBrandom\&.h\fP\&.
.PP
References \fBstd::normal_distribution< _RealType >::reset()\fP\&.
.SS "template<\fBtypename\fP _IntType  = int> _IntType \fBstd::binomial_distribution\fP< _IntType >::t () const\fC [inline]\fP"

.PP
Returns the distribution \fCt\fP parameter\&. 
.PP
Definition at line \fB3815\fP of file \fBrandom\&.h\fP\&.
.SH "Friends And Related Symbol Documentation"
.PP 
.SS "template<\fBtypename\fP _IntType  = int> template<\fBtypename\fP \fB_IntType1\fP , \fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstd::basic_ostream\fP< _CharT, _Traits > & \fBoperator\fP<< (\fBstd::basic_ostream\fP< _CharT, _Traits > & __os, \fBconst\fP \fBstd::binomial_distribution\fP< \fB_IntType1\fP > & __x)\fC [friend]\fP"

.PP
Inserts a binomial_distribution random number distribution \fC__x\fP into the output stream \fC__os\fP\&. 
.PP
\fBParameters\fP
.RS 4
\fI__os\fP An output stream\&. 
.br
\fI__x\fP A binomial_distribution random number distribution\&.
.RE
.PP
\fBReturns\fP
.RS 4
The output stream with the state of \fC__x\fP inserted or in an error state\&. 
.RE
.PP

.SS "template<\fBtypename\fP _IntType  = int> bool \fBoperator\fP== (\fBconst\fP \fBbinomial_distribution\fP< _IntType > & __d1, \fBconst\fP \fBbinomial_distribution\fP< _IntType > & __d2)\fC [friend]\fP"

.PP
Return true if two binomial distributions have the same parameters and the sequences that would be generated are equal\&. 
.PP
Definition at line \fB3895\fP of file \fBrandom\&.h\fP\&.
.SS "template<\fBtypename\fP _IntType  = int> template<\fBtypename\fP \fB_IntType1\fP , \fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstd::basic_istream\fP< _CharT, _Traits > & \fBoperator\fP>> (\fBstd::basic_istream\fP< _CharT, _Traits > & __is, \fBstd::binomial_distribution\fP< \fB_IntType1\fP > & __x)\fC [friend]\fP"

.PP
Extracts a binomial_distribution random number distribution \fC__x\fP from the input stream \fC__is\fP\&. 
.PP
\fBParameters\fP
.RS 4
\fI__is\fP An input stream\&. 
.br
\fI__x\fP A binomial_distribution random number generator engine\&.
.RE
.PP
\fBReturns\fP
.RS 4
The input stream with \fC__x\fP extracted or in an error state\&. 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for libstdc++ from the source code\&.