libstdc++
Classes | Public Types | Public Member Functions | Friends | List of all members
std::cauchy_distribution< _RealType > Class Template Reference
Numerics » Random Number Generation » Random Number Distributions » Normal Distributions

#include <random.h>

Classes

struct  param_type
 

Public Types

typedef _RealType result_type
 

Public Member Functions

 cauchy_distribution (_RealType __a, _RealType __b=1.0)
 
 cauchy_distribution (const param_type &__p)
 
template<typename _ForwardIterator , typename _UniformRandomNumberGenerator >
void __generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng)
 
template<typename _ForwardIterator , typename _UniformRandomNumberGenerator >
void __generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng, const param_type &__p)
 
template<typename _UniformRandomNumberGenerator >
void __generate (result_type *__f, result_type *__t, _UniformRandomNumberGenerator &__urng, const param_type &__p)
 
_RealType a () const
 
_RealType b () const
 
result_type max () const
 
result_type min () const
 
template<typename _UniformRandomNumberGenerator >
result_type operator() (_UniformRandomNumberGenerator &__urng)
 
template<typename _UniformRandomNumberGenerator >
result_type operator() (_UniformRandomNumberGenerator &__urng, const param_type &__p)
 
param_type param () const
 
void param (const param_type &__param)
 
void reset ()
 

Friends

bool operator== (const cauchy_distribution &__d1, const cauchy_distribution &__d2)
 

Detailed Description

template<typename _RealType = double>
class std::cauchy_distribution< _RealType >

A cauchy_distribution random number distribution.

The formula for the normal probability mass function is $p(x|a,b) = (\pi b (1 + (\frac{x-a}{b})^2))^{-1}$

Definition at line 2856 of file random.h.

Member Typedef Documentation

◆ result_type

template<typename _RealType = double>
typedef _RealType std::cauchy_distribution< _RealType >::result_type

The type of the range of the distribution.

Definition at line 2863 of file random.h.

Constructor & Destructor Documentation

◆ cauchy_distribution() [1/3]

template<typename _RealType = double>
std::cauchy_distribution< _RealType >::cauchy_distribution ( )
inline

Definition at line 2898 of file random.h.

◆ cauchy_distribution() [2/3]

template<typename _RealType = double>
std::cauchy_distribution< _RealType >::cauchy_distribution ( _RealType  __a,
_RealType  __b = 1.0 
)
inlineexplicit

Definition at line 2901 of file random.h.

◆ cauchy_distribution() [3/3]

template<typename _RealType = double>
std::cauchy_distribution< _RealType >::cauchy_distribution ( const param_type &  __p)
inlineexplicit

Definition at line 2906 of file random.h.

Member Function Documentation

◆ __generate() [1/3]

template<typename _RealType = double>
template<typename _ForwardIterator , typename _UniformRandomNumberGenerator >
void std::cauchy_distribution< _RealType >::__generate ( _ForwardIterator  __f,
_ForwardIterator  __t,
_UniformRandomNumberGenerator &  __urng 
)
inline

Definition at line 2973 of file random.h.

◆ __generate() [2/3]

template<typename _RealType = double>
template<typename _ForwardIterator , typename _UniformRandomNumberGenerator >
void std::cauchy_distribution< _RealType >::__generate ( _ForwardIterator  __f,
_ForwardIterator  __t,
_UniformRandomNumberGenerator &  __urng,
const param_type &  __p 
)
inline

Definition at line 2980 of file random.h.

◆ __generate() [3/3]

template<typename _RealType = double>
template<typename _UniformRandomNumberGenerator >
void std::cauchy_distribution< _RealType >::__generate ( result_type *  __f,
result_type *  __t,
_UniformRandomNumberGenerator &  __urng,
const param_type &  __p 
)
inline

Definition at line 2987 of file random.h.

◆ a()

template<typename _RealType = double>
_RealType std::cauchy_distribution< _RealType >::a ( ) const
inline

Definition at line 2921 of file random.h.

◆ b()

template<typename _RealType = double>
_RealType std::cauchy_distribution< _RealType >::b ( ) const
inline

Definition at line 2925 of file random.h.

◆ max()

template<typename _RealType = double>
result_type std::cauchy_distribution< _RealType >::max ( ) const
inline

Returns the least upper bound value of the distribution.

Definition at line 2954 of file random.h.

References std::numeric_limits< _Tp >::max().

◆ min()

template<typename _RealType = double>
result_type std::cauchy_distribution< _RealType >::min ( ) const
inline

Returns the greatest lower bound value of the distribution.

Definition at line 2947 of file random.h.

References std::numeric_limits< _Tp >::lowest().

◆ operator()() [1/2]

template<typename _RealType = double>
template<typename _UniformRandomNumberGenerator >
result_type std::cauchy_distribution< _RealType >::operator() ( _UniformRandomNumberGenerator &  __urng)
inline

Generating functions.

Definition at line 2962 of file random.h.

References std::cauchy_distribution< _RealType >::operator()().

Referenced by std::cauchy_distribution< _RealType >::operator()().

◆ operator()() [2/2]

template<typename _RealType >
template<typename _UniformRandomNumberGenerator >
cauchy_distribution< _RealType >::result_type std::cauchy_distribution< _RealType >::operator() ( _UniformRandomNumberGenerator &  __urng,
const param_type &  __p 
)

Definition at line 2103 of file bits/random.tcc.

◆ param() [1/2]

template<typename _RealType = double>
param_type std::cauchy_distribution< _RealType >::param ( ) const
inline

Returns the parameter set of the distribution.

Definition at line 2932 of file random.h.

Referenced by std::operator>>().

◆ param() [2/2]

template<typename _RealType = double>
void std::cauchy_distribution< _RealType >::param ( const param_type &  __param)
inline

Sets the parameter set of the distribution.

Parameters
__paramThe new parameter set of the distribution.

Definition at line 2940 of file random.h.

◆ reset()

template<typename _RealType = double>
void std::cauchy_distribution< _RealType >::reset ( )
inline

Resets the distribution state.

Definition at line 2914 of file random.h.

Friends And Related Symbol Documentation

◆ operator==

template<typename _RealType = double>
bool operator== ( const cauchy_distribution< _RealType > &  __d1,
const cauchy_distribution< _RealType > &  __d2 
)
friend

Return true if two Cauchy distributions have the same parameters.

Definition at line 2997 of file random.h.

The documentation for this class was generated from the following files: