std::cauchy_distribution (3) - Linux Manuals

std::cauchy_distribution: std::cauchy_distribution

NAME

std::cauchy_distribution - std::cauchy_distribution

Synopsis


Defined in header <random>
template< class RealType = double > (since C++11)
class cauchy_distribution;


Produces random numbers according to a Cauchy distribution (also called Lorentz distribution):


      f(x; a,b) = ⎛
      ⎜
      ⎝bπ ⎡
      ⎢
      ⎣1 + ⎛
      ⎜
      ⎝


      x - a
      b


      ⎞
      ⎟
      ⎠2
      ⎤
      ⎥
      ⎦⎞
      ⎟
      ⎠-1


std::cauchy_distribution satisfies all requirements of RandomNumberDistribution

Template parameters


RealType - The result type generated by the generator. The effect is undefined if this is not one of float, double, or long double.

Member types


Member type Definition
result_type RealType
param_type the type of the parameter set, see RandomNumberDistribution.

Member functions


              constructs new distribution
constructor (public member function)
              resets the internal state of the distribution
reset (public member function)

Generation


              generates the next random number in the distribution
operator() (public member function)

Characteristics


              returns the distribution parameters
a (public member function)
b
              gets or sets the distribution parameter object
param (public member function)
              returns the minimum potentially generated value
min (public member function)
              returns the maximum potentially generated value
max (public member function)

Non-member functions


           compares two distribution objects
operator== (function)
operator!=
           performs stream input and output on pseudo-random number distribution
operator<< (function template)
operator>>

Example


 This section is incomplete
 Reason: no example

External links


Weisstein,_Eric_W._"Cauchy_Distribution." From MathWorld--A Wolfram Web Resource. Cauchy_Distribution. From Wikipedia.