26 Numerics library [numerics]

26.6 Random number generation [rand]

26.6.8 Random number distribution class templates [rand.dist]

26.6.8.5 Normal distributions [rand.dist.norm]

26.6.8.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\[% p(x\,|\,a,b) = \left( \pi b \left( 1 + \left( \frac{x-a}{b} \right)^2 \;\right)\right)^{-1} \; \mbox{.} \]

template<class RealType = double>
 class cauchy_distribution{
public:
 // types
 using result_type = RealType;
 using param_type  = unspecified;

 // constructor and reset functions
 explicit cauchy_distribution(RealType a = 0.0, RealType b = 1.0);
 explicit cauchy_distribution(const param_type& parm);
 void reset();

 // 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;
};

explicit cauchy_distribution(RealType a = 0.0, RealType b = 1.0);

2

Requires: 0 < b .

3

Effects: Constructs a cauchy_distribution object; 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.