.TH "std::binomial_distribution< _IntType >" 3cxx "Tue Jul 18 2023" "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 "typedef _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 (const \fBparam_type\fP &__p)"
.br
.ti -1c
.RI "template<typename _ForwardIterator , typename _UniformRandomNumberGenerator > void \fB__generate\fP (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng)"
.br
.ti -1c
.RI "template<typename _ForwardIterator , typename _UniformRandomNumberGenerator > void \fB__generate\fP (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng, const \fBparam_type\fP &__p)"
.br
.ti -1c
.RI "template<typename _UniformRandomNumberGenerator > void \fB__generate\fP (\fBresult_type\fP *__f, \fBresult_type\fP *__t, _UniformRandomNumberGenerator &__urng, const \fBparam_type\fP &__p)"
.br
.ti -1c
.RI "\fBresult_type\fP \fBmax\fP () const"
.br
.RI "Returns the least upper bound value of the distribution\&. "
.ti -1c
.RI "\fBresult_type\fP \fBmin\fP () const"
.br
.RI "Returns the greatest lower bound value of the distribution\&. "
.ti -1c
.RI "template<typename _UniformRandomNumberGenerator > \fBresult_type\fP \fBoperator()\fP (_UniformRandomNumberGenerator &__urng)"
.br
.RI "Generating functions\&. "
.ti -1c
.RI "template<typename _UniformRandomNumberGenerator > \fBresult_type\fP \fBoperator()\fP (_UniformRandomNumberGenerator &__urng, const \fBparam_type\fP &__p)"
.br
.ti -1c
.RI "double \fBp\fP () const"
.br
.RI "Returns the distribution \fCp\fP parameter\&. "
.ti -1c
.RI "\fBparam_type\fP \fBparam\fP () const"
.br
.RI "Returns the parameter set of the distribution\&. "
.ti -1c
.RI "void \fBparam\fP (const \fBparam_type\fP &__param)"
.br
.RI "Sets the parameter set of the distribution\&. "
.ti -1c
.RI "void \fBreset\fP ()"
.br
.RI "Resets the distribution state\&. "
.ti -1c
.RI "_IntType \fBt\fP () const"
.br
.RI "Returns the distribution \fCt\fP parameter\&. "
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "template<typename _IntType1 , typename _CharT , typename _Traits > \fBstd::basic_ostream\fP< _CharT, _Traits > & \fBoperator<<\fP (\fBstd::basic_ostream\fP< _CharT, _Traits > &__os, const \fBstd::binomial_distribution\fP< _IntType1 > &__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 (const \fBbinomial_distribution\fP &__d1, const \fBbinomial_distribution\fP &__d2)"
.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<typename _IntType1 , typename _CharT , typename _Traits > \fBstd::basic_istream\fP< _CharT, _Traits > & \fBoperator>>\fP (\fBstd::basic_istream\fP< _CharT, _Traits > &__is, \fBstd::binomial_distribution\fP< _IntType1 > &__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<typename _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\&. 
.SH "Member Typedef Documentation"
.PP 
.SS "template<typename _IntType  = int> typedef _IntType \fBstd::binomial_distribution\fP< _IntType >::result_type"
The type of the range of the distribution\&. 
.SH "Member Function Documentation"
.PP 
.SS "template<typename _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\&. 
.SS "template<typename _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\&. 
.SS "template<typename _IntType  = int> template<typename _UniformRandomNumberGenerator > \fBresult_type\fP \fBstd::binomial_distribution\fP< _IntType >::operator() (_UniformRandomNumberGenerator & __urng)\fC [inline]\fP"

.PP
Generating functions\&. 
.PP
References \fBstd::binomial_distribution< _IntType >::operator()()\fP\&.
.PP
Referenced by \fBstd::binomial_distribution< _IntType >::operator()()\fP\&.
.SS "template<typename _IntType > template<typename _UniformRandomNumberGenerator > \fBbinomial_distribution\fP< _IntType >\fB::result_type\fP \fBstd::binomial_distribution\fP< _IntType >::operator() (_UniformRandomNumberGenerator & __urng, const \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
References \fBstd::abs()\fP, \fBstd::numeric_limits< _Tp >::epsilon()\fP, \fBstd::log()\fP, and \fBstd::numeric_limits< _Tp >::max()\fP\&.
.SS "template<typename _IntType  = int> double \fBstd::binomial_distribution\fP< _IntType >::p () const\fC [inline]\fP"

.PP
Returns the distribution \fCp\fP parameter\&. 
.SS "template<typename _IntType  = int> \fBparam_type\fP \fBstd::binomial_distribution\fP< _IntType >::param () const\fC [inline]\fP"

.PP
Returns the parameter set of the distribution\&. 
.SS "template<typename _IntType  = int> void \fBstd::binomial_distribution\fP< _IntType >::param (const \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

.SS "template<typename _IntType  = int> void \fBstd::binomial_distribution\fP< _IntType >::reset ()\fC [inline]\fP"

.PP
Resets the distribution state\&. 
.PP
References \fBstd::normal_distribution< _RealType >::reset()\fP\&.
.SS "template<typename _IntType  = int> _IntType \fBstd::binomial_distribution\fP< _IntType >::t () const\fC [inline]\fP"

.PP
Returns the distribution \fCt\fP parameter\&. 
.SH "Friends And Related Function Documentation"
.PP 
.SS "template<typename _IntType  = int> template<typename _IntType1 , typename _CharT , typename _Traits > \fBstd::basic_ostream\fP< _CharT, _Traits > & operator<< (\fBstd::basic_ostream\fP< _CharT, _Traits > & __os, const \fBstd::binomial_distribution\fP< _IntType1 > & __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<typename _IntType  = int> bool operator== (const \fBbinomial_distribution\fP< _IntType > & __d1, const \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\&. 
.SS "template<typename _IntType  = int> template<typename _IntType1 , typename _CharT , typename _Traits > \fBstd::basic_istream\fP< _CharT, _Traits > & operator>> (\fBstd::basic_istream\fP< _CharT, _Traits > & __is, \fBstd::binomial_distribution\fP< _IntType1 > & __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\&.