28
Numerics library
[numerics]
28.5
Random number generation
[rand]
28.5.9
Random number distribution class templates
[rand.dist]
28.5.9.5
Normal distributions
[rand.dist.norm]
28.5.9.5.4
Class template
cauchy_
distribution
[rand.dist.norm.cauchy]
1
#
A
cauchy_
distribution
random number distribution produces random numbers
x
distributed according to the probability density function in Formula
28.16
.
p
(
x
|
a
,
b
)
=
(
π
b
(
1
+
(
x
−
a
b
)
2
)
)
−
1
(28.16)
🔗
namespace
std
{
template
<
class
RealType
=
double
>
class
cauchy_distribution
{
public
:
// types
using
result_type
=
RealType;
using
param_type
=
unspecified
;
// constructor and reset functions
cauchy_distribution
(
)
:
cauchy_distribution
(
0.0
)
{
}
explicit
cauchy_distribution
(
RealType a, RealType b
=
1.0
)
;
explicit
cauchy_distribution
(
const
param_type
&
parm
)
;
void
reset
(
)
;
// equality operators
friend
bool
operator
=
=
(
const
cauchy_distribution
&
x,
const
cauchy_distribution
&
y
)
;
// generating functions
template
<
class
URBG
>
result_type
operator
(
)
(
URBG
&
g
)
;
template
<
class
URBG
>
result_type
operator
(
)
(
URBG
&
g,
const
param_type
&
parm
)
;
// property functions
RealType a
(
)
const
; RealType b
(
)
const
; param_type param
(
)
const
;
void
param
(
const
param_type
&
parm
)
; result_type min
(
)
const
; result_type max
(
)
const
;
// inserters and extractors
template
<
class
charT,
class
traits
>
friend
basic_ostream
<
charT, traits
>
&
operator
<
<
(
basic_ostream
<
charT, traits
>
&
os,
const
cauchy_distribution
&
x
)
;
template
<
class
charT,
class
traits
>
friend
basic_istream
<
charT, traits
>
&
operator
>
>
(
basic_istream
<
charT, traits
>
&
is, cauchy_distribution
&
x
)
;
}
;
}
🔗
explicit
cauchy_distribution
(
RealType a, RealType b
=
1.0
)
;
2
#
Preconditions
:
0
<
b
.
3
#
Remarks
:
a
and
b
correspond to the respective parameters of the distribution
.
🔗
RealType a
(
)
const
;
4
#
Returns
: The value of the
a
parameter with which the object was constructed
.
🔗
RealType b
(
)
const
;
5
#
Returns
: The value of the
b
parameter with which the object was constructed
.