.TH "std::bernoulli_distribution" 3cxx "Fri May 28 2021" "libstdc++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
std::bernoulli_distribution \- A Bernoulli random number distribution\&.  

.SH SYNOPSIS
.br
.PP
.SS "Classes"

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

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

.in +1c
.ti -1c
.RI "\fBbernoulli_distribution\fP ()"
.br
.RI "Constructs a Bernoulli distribution with likelihood 0\&.5\&. "
.ti -1c
.RI "\fBbernoulli_distribution\fP (const \fBparam_type\fP &__p)"
.br
.ti -1c
.RI "\fBbernoulli_distribution\fP (double __p)"
.br
.RI "Constructs a Bernoulli distribution with likelihood \fCp\fP\&. "
.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 \fCp\fP parameter of the distribution\&. "
.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\&. "
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "bool \fBoperator==\fP (const \fBbernoulli_distribution\fP &__d1, const \fBbernoulli_distribution\fP &__d2)"
.br
.RI "Return true if two Bernoulli distributions have the same parameters\&. "
.in -1c
.SH "Detailed Description"
.PP 
A Bernoulli random number distribution\&. 

Generates a sequence of true and false values with likelihood $p$ that true will come up and $(1 - p)$ that false will appear\&. 
.PP
Definition at line 3515 of file random\&.h\&.
.SH "Member Typedef Documentation"
.PP 
.SS "typedef bool \fBstd::bernoulli_distribution::result_type\fP"
The type of the range of the distribution\&. 
.PP
Definition at line 3519 of file random\&.h\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "std::bernoulli_distribution::bernoulli_distribution ()\fC [inline]\fP"

.PP
Constructs a Bernoulli distribution with likelihood 0\&.5\&. 
.PP
Definition at line 3555 of file random\&.h\&.
.SS "std::bernoulli_distribution::bernoulli_distribution (double __p)\fC [inline]\fP, \fC [explicit]\fP"

.PP
Constructs a Bernoulli distribution with likelihood \fCp\fP\&. 
.PP
\fBParameters\fP
.RS 4
\fI__p\fP [IN] The likelihood of a true result being returned\&. Must be in the interval $[0, 1]$\&. 
.RE
.PP

.PP
Definition at line 3564 of file random\&.h\&.
.SH "Member Function Documentation"
.PP 
.SS "\fBresult_type\fP std::bernoulli_distribution::max () const\fC [inline]\fP"

.PP
Returns the least upper bound value of the distribution\&. 
.PP
Definition at line 3614 of file random\&.h\&.
.PP
References std::numeric_limits< _Tp >::max()\&.
.SS "\fBresult_type\fP std::bernoulli_distribution::min () const\fC [inline]\fP"

.PP
Returns the greatest lower bound value of the distribution\&. 
.PP
Definition at line 3607 of file random\&.h\&.
.PP
References std::numeric_limits< _Tp >::min()\&.
.SS "template<typename _UniformRandomNumberGenerator > \fBresult_type\fP std::bernoulli_distribution::operator() (_UniformRandomNumberGenerator & __urng)\fC [inline]\fP"

.PP
Generating functions\&. 
.PP
Definition at line 3622 of file random\&.h\&.
.SS "double std::bernoulli_distribution::p () const\fC [inline]\fP"

.PP
Returns the \fCp\fP parameter of the distribution\&. 
.PP
Definition at line 3585 of file random\&.h\&.
.SS "\fBparam_type\fP std::bernoulli_distribution::param () const\fC [inline]\fP"

.PP
Returns the parameter set of the distribution\&. 
.PP
Definition at line 3592 of file random\&.h\&.
.PP
Referenced by std::operator>>()\&.
.SS "void std::bernoulli_distribution::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

.PP
Definition at line 3600 of file random\&.h\&.
.SS "void std::bernoulli_distribution::reset ()\fC [inline]\fP"

.PP
Resets the distribution state\&. Does nothing for a Bernoulli distribution\&. 
.PP
Definition at line 3579 of file random\&.h\&.
.SH "Friends And Related Function Documentation"
.PP 
.SS "bool operator== (const \fBbernoulli_distribution\fP & __d1, const \fBbernoulli_distribution\fP & __d2)\fC [friend]\fP"

.PP
Return true if two Bernoulli distributions have the same parameters\&. 
.PP
Definition at line 3664 of file random\&.h\&.

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