public member function
<random>

std::cauchy_distribution::(constructor)

(1)
explicit cauchy_distribution ( result_type a = 0.0, result_type b = 1.0 );
(2)
explicit cauchy_distribution ( const param_type& parm );
Construct Cachy distribution
Constructs a cauchy_distribution object, adopting the distribution parameters specified either by a and b or by object parm.

Parameters

a
Distribution parameter a, which specifies the location of the peak (its mode).
result_type is a member type that represents the type of the random numbers generated on each call to operator(). It is defined as an alias of the first class template parameter (RealType).
b
Distribution parameter b, which defines the scale of the distribution.
This shall be a positive value (b>0).
result_type is a member type that represents the type of the random numbers generated on each call to operator(). It is defined as an alias of the first class template parameter (RealType).
parm
An object representing the distribution's parameters, obtained by a call to member function param.
param_type is a member type.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// cauchy_distribution example
#include <iostream>
#include <chrono>
#include <random>

int main()
{
  // construct a trivial random generator engine from a time-based seed:
  unsigned seed = std::chrono::system_clock::now().time_since_epoch().count();
  std::default_random_engine generator (seed);

  std::cauchy_distribution<double> distribution (0.0,1.0);

  std::cout << "some Cauchy-distributed(0.0,1.0) results:" << std::endl;
  for (int i=0; i<5; ++i)
    std::cout << distribution(generator) << std::endl;

  return 0;
}

Possible output:
some Cauchy-distributed(0.0,1.0) results:
0.544036
-1.36065
2.94442
-0.762972
1.2017


Complexity

Constant.

See also