.TH "std::cauchy_distribution< _RealType >" 3cxx "Thu Feb 16 2023" "libstdc++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
std::cauchy_distribution< _RealType > \- A cauchy_distribution 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 _RealType \fBresult_type\fP"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBcauchy_distribution\fP (_RealType __a, _RealType __b=1\&.0)"
.br
.ti -1c
.RI "\fBcauchy_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 "_RealType \fBa\fP () const"
.br
.ti -1c
.RI "_RealType \fBb\fP () const"
.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 "\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 \fBcauchy_distribution\fP &__d1, const \fBcauchy_distribution\fP &__d2)"
.br
.RI "Return true if two Cauchy distributions have the same parameters\&. "
.in -1c
.SH "Detailed Description"
.PP 

.SS "template<typename _RealType = double>
.br
class std::cauchy_distribution< _RealType >"A cauchy_distribution random number distribution\&. 

The formula for the normal probability mass function is $p(x|a,b) = (\pi b (1 + (\frac{x-a}{b})^2))^{-1}$ 
.PP
Definition at line \fB2856\fP of file \fBrandom\&.h\fP\&.
.SH "Member Typedef Documentation"
.PP 
.SS "template<typename _RealType  = double> typedef _RealType \fBstd::cauchy_distribution\fP< _RealType >::result_type"
The type of the range of the distribution\&. 
.PP
Definition at line \fB2863\fP of file \fBrandom\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "template<typename _RealType  = double> \fBstd::cauchy_distribution\fP< _RealType >::cauchy_distribution ()\fC [inline]\fP"

.PP
Definition at line \fB2898\fP of file \fBrandom\&.h\fP\&.
.SS "template<typename _RealType  = double> \fBstd::cauchy_distribution\fP< _RealType >::cauchy_distribution (_RealType __a, _RealType __b = \fC1\&.0\fP)\fC [inline]\fP, \fC [explicit]\fP"

.PP
Definition at line \fB2901\fP of file \fBrandom\&.h\fP\&.
.SS "template<typename _RealType  = double> \fBstd::cauchy_distribution\fP< _RealType >::cauchy_distribution (const \fBparam_type\fP & __p)\fC [inline]\fP, \fC [explicit]\fP"

.PP
Definition at line \fB2906\fP of file \fBrandom\&.h\fP\&.
.SH "Member Function Documentation"
.PP 
.SS "template<typename _RealType  = double> template<typename _ForwardIterator , typename _UniformRandomNumberGenerator > void \fBstd::cauchy_distribution\fP< _RealType >::__generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator & __urng)\fC [inline]\fP"

.PP
Definition at line \fB2973\fP of file \fBrandom\&.h\fP\&.
.SS "template<typename _RealType  = double> template<typename _ForwardIterator , typename _UniformRandomNumberGenerator > void \fBstd::cauchy_distribution\fP< _RealType >::__generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator & __urng, const \fBparam_type\fP & __p)\fC [inline]\fP"

.PP
Definition at line \fB2980\fP of file \fBrandom\&.h\fP\&.
.SS "template<typename _RealType  = double> template<typename _UniformRandomNumberGenerator > void \fBstd::cauchy_distribution\fP< _RealType >::__generate (\fBresult_type\fP * __f, \fBresult_type\fP * __t, _UniformRandomNumberGenerator & __urng, const \fBparam_type\fP & __p)\fC [inline]\fP"

.PP
Definition at line \fB2987\fP of file \fBrandom\&.h\fP\&.
.SS "template<typename _RealType  = double> _RealType \fBstd::cauchy_distribution\fP< _RealType >::a () const\fC [inline]\fP"

.PP
Definition at line \fB2921\fP of file \fBrandom\&.h\fP\&.
.SS "template<typename _RealType  = double> _RealType \fBstd::cauchy_distribution\fP< _RealType >::b () const\fC [inline]\fP"

.PP
Definition at line \fB2925\fP of file \fBrandom\&.h\fP\&.
.SS "template<typename _RealType  = double> \fBresult_type\fP \fBstd::cauchy_distribution\fP< _RealType >::max () const\fC [inline]\fP"

.PP
Returns the least upper bound value of the distribution\&. 
.PP
Definition at line \fB2954\fP of file \fBrandom\&.h\fP\&.
.PP
References \fBstd::numeric_limits< _Tp >::max()\fP\&.
.SS "template<typename _RealType  = double> \fBresult_type\fP \fBstd::cauchy_distribution\fP< _RealType >::min () const\fC [inline]\fP"

.PP
Returns the greatest lower bound value of the distribution\&. 
.PP
Definition at line \fB2947\fP of file \fBrandom\&.h\fP\&.
.PP
References \fBstd::numeric_limits< _Tp >::lowest()\fP\&.
.SS "template<typename _RealType  = double> template<typename _UniformRandomNumberGenerator > \fBresult_type\fP \fBstd::cauchy_distribution\fP< _RealType >::operator() (_UniformRandomNumberGenerator & __urng)\fC [inline]\fP"

.PP
Generating functions\&. 
.PP
Definition at line \fB2962\fP of file \fBrandom\&.h\fP\&.
.PP
References \fBstd::cauchy_distribution< _RealType >::operator()()\fP\&.
.PP
Referenced by \fBstd::cauchy_distribution< _RealType >::operator()()\fP\&.
.SS "template<typename _RealType > template<typename _UniformRandomNumberGenerator > \fBcauchy_distribution\fP< _RealType >\fB::result_type\fP \fBstd::cauchy_distribution\fP< _RealType >::operator() (_UniformRandomNumberGenerator & __urng, const \fBparam_type\fP & __p)"

.PP
Definition at line \fB2103\fP of file \fBbits/random\&.tcc\fP\&.
.SS "template<typename _RealType  = double> \fBparam_type\fP \fBstd::cauchy_distribution\fP< _RealType >::param () const\fC [inline]\fP"

.PP
Returns the parameter set of the distribution\&. 
.PP
Definition at line \fB2932\fP of file \fBrandom\&.h\fP\&.
.PP
Referenced by \fBstd::operator>>()\fP\&.
.SS "template<typename _RealType  = double> void \fBstd::cauchy_distribution\fP< _RealType >::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 \fB2940\fP of file \fBrandom\&.h\fP\&.
.SS "template<typename _RealType  = double> void \fBstd::cauchy_distribution\fP< _RealType >::reset ()\fC [inline]\fP"

.PP
Resets the distribution state\&. 
.PP
Definition at line \fB2914\fP of file \fBrandom\&.h\fP\&.
.SH "Friends And Related Function Documentation"
.PP 
.SS "template<typename _RealType  = double> bool operator== (const \fBcauchy_distribution\fP< _RealType > & __d1, const \fBcauchy_distribution\fP< _RealType > & __d2)\fC [friend]\fP"

.PP
Return true if two Cauchy distributions have the same parameters\&. 
.PP
Definition at line \fB2997\fP of file \fBrandom\&.h\fP\&.

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