std_cauchy_distribution.3cxx

Langue: en

Version: 344407 (ubuntu - 24/10/10)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

std::cauchy_distribution -

A cauchy_distribution random number distribution.

SYNOPSIS


Classes


struct param_type

Public Types


typedef _RealType result_type

Public Member Functions


cauchy_distribution (_RealType __a=_RealType(0), _RealType __b=_RealType(1))

cauchy_distribution (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, const param_type &__p)

template<typename _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator &__urng)

void param (const param_type &__param)

param_type param () const

void reset ()

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) = (
i b (1 + (ac{x-a}{b})^2))^{-1}$

Definition at line 2704 of file random.h.

Member Typedef Documentation

template<typename _RealType = double> typedef _RealType std::cauchy_distribution< _RealType >::result_typeThe type of the range of the distribution.

Definition at line 2711 of file random.h.

Member Function Documentation

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 2795 of file random.h.

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 2788 of file random.h.

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

Generating functions.

Definition at line 2803 of file random.h.

References std::cauchy_distribution< _RealType >::operator()(), and std::cauchy_distribution< _RealType >::param().

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

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

Sets the parameter set of the distribution. Parameters:

__param The new parameter set of the distribution.

Definition at line 2781 of file random.h.

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

Returns the parameter set of the distribution.

Definition at line 2773 of file random.h.

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

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

Resets the distribution state.

Definition at line 2755 of file random.h.

Author

Generated automatically by Doxygen for libstdc++ from the source code.