onemkl::rng::cauchy

Generates Cauchy distributed random values.

Syntax

template<typename T = float, method Method =      inverse_function>
  class cauchy {
  public:
    cauchy(): cauchy((T)0.0, (T)1.0){}
    cauchy(T a, T b)
    cauchy(const cauchy<T, Method>& other)
    T a() const
    T b() const
    cauchy<T, Method>& operator=(const cauchy<T, Method>& other)
  }

Include Files

  • mkl_sycl.hpp

Description

The onemkl::rng::cauchy class object is used in the onemkl::rng::generate function to provide Cauchy distributed random numbers with displacement (a) and scalefactor (b, β), where a, β∈R ; β > 0.

The probability density function is given by:


image0

The cumulative distribution function is as follows:


image1

Input Parameters

Name

Type

Description

method

onemkl::rng::method

Generation method. The specific values are as follows: onemkl::rng::inverse_function See brief descriptions of the methods in Distributions Template Parameter onemkl::rng::method Values.

a

T (float, double)

Displacement a.

b

T (float, double)

Scalefactor b.