mckl::RayleighDistribution< RealType > Class Template Reference

Rayleigh distribution. More...

#include <mckl/random/internal/common.hpp>

Classes
class	param_type

Public Types
using	distribution_type = RayleighDistribution< RealType >
using	result_type = RealType

Public Member Functions
	RayleighDistribution (result_type sigma=1)
	RayleighDistribution (const param_type &param)
	RayleighDistribution (param_type &&param)
result_type	max () const
result_type	min () const
template<typename RNGType >
result_type	operator() (RNGType &rng)
template<typename RNGType >
result_type	operator() (RNGType &rng, const param_type &param)
template<typename RNGType >
void	operator() (RNGType &rng, std::size_t n, result_type *r)
template<typename RNGType >
void	operator() (RNGType &rng, std::size_t n, result_type *r, const param_type &param)
void	param (const param_type &param)
const param_type &	param () const
void	param (param_type &&param)
void	reset ()
result_type	sigma () const

Friends
bool	operator!= (const distribution_type &dist1, const distribution_type &dist2)
template<typename CharT , typename Traits >
std::basic_ostream< CharT, Traits > &	operator<< (std::basic_ostream< CharT, Traits > &os, const distribution_type &dist)
bool	operator== (const distribution_type &dist1, const distribution_type &dist2)
template<typename CharT , typename Traits >
std::basic_istream< CharT, Traits > &	operator>> (std::basic_istream< CharT, Traits > &is, distribution_type &dist)

Detailed Description

template<typename RealType>
class mckl::RayleighDistribution< RealType >

Rayleigh distribution.

Definition at line 1063 of file random/internal/common.hpp.

Member Typedef Documentation

distribution_type

template<typename RealType >

using mckl::RayleighDistribution< RealType >::distribution_type = RayleighDistribution< RealType >

Definition at line 70 of file rayleigh_distribution.hpp.

result_type

template<typename RealType >

using mckl::RayleighDistribution< RealType >::result_type = RealType

Definition at line 70 of file rayleigh_distribution.hpp.

Constructor & Destructor Documentation

RayleighDistribution() [1/3]

template<typename RealType >

mckl::RayleighDistribution< RealType >::RayleighDistribution ( result_type  sigma = 1 )

inlineexplicit

Definition at line 70 of file rayleigh_distribution.hpp.

RayleighDistribution() [2/3]

template<typename RealType >

mckl::RayleighDistribution< RealType >::RayleighDistribution ( const param_type &  param )

inlineexplicit

Definition at line 70 of file rayleigh_distribution.hpp.

RayleighDistribution() [3/3]

template<typename RealType >

mckl::RayleighDistribution< RealType >::RayleighDistribution ( param_type &&  param )

inlineexplicit

Definition at line 70 of file rayleigh_distribution.hpp.

Member Function Documentation

max()

template<typename RealType >

result_type mckl::RayleighDistribution< RealType >::max ( ) const

inline

Definition at line 76 of file rayleigh_distribution.hpp.

min()

template<typename RealType >

result_type mckl::RayleighDistribution< RealType >::min ( ) const

inline

Definition at line 74 of file rayleigh_distribution.hpp.

operator()() [1/4]

template<typename RealType >

template<typename RNGType >

void mckl::RayleighDistribution< RealType >::operator() ( RNGType &  rng, std::size_t  n, result_type *  r, const param_type &  param  )

inline

Definition at line 70 of file rayleigh_distribution.hpp.

operator()() [2/4]

template<typename RealType >

template<typename RNGType >

result_type mckl::RayleighDistribution< RealType >::operator() ( RNGType &  rng )

inline

Definition at line 70 of file rayleigh_distribution.hpp.

operator()() [3/4]

template<typename RealType >

template<typename RNGType >

result_type mckl::RayleighDistribution< RealType >::operator() ( RNGType &  rng, const param_type &  param  )

inline

Definition at line 70 of file rayleigh_distribution.hpp.

operator()() [4/4]

template<typename RealType >

template<typename RNGType >

void mckl::RayleighDistribution< RealType >::operator() ( RNGType &  rng, std::size_t  n, result_type *  r  )

inline

Definition at line 70 of file rayleigh_distribution.hpp.

param() [1/3]

template<typename RealType >

const param_type& mckl::RayleighDistribution< RealType >::param ( ) const

inline

Definition at line 70 of file rayleigh_distribution.hpp.

param() [2/3]

template<typename RealType >

void mckl::RayleighDistribution< RealType >::param ( param_type &&  param )

inline

Definition at line 70 of file rayleigh_distribution.hpp.

param() [3/3]

template<typename RealType >

void mckl::RayleighDistribution< RealType >::param ( const param_type &  param )

inline

Definition at line 70 of file rayleigh_distribution.hpp.

reset()

template<typename RealType >

void mckl::RayleighDistribution< RealType >::reset ( )

inline

Definition at line 78 of file rayleigh_distribution.hpp.

sigma()

template<typename RealType >

result_type mckl::RayleighDistribution< RealType >::sigma ( ) const

inline

Definition at line 70 of file rayleigh_distribution.hpp.

Friends And Related Function Documentation

operator!=

template<typename RealType >

bool operator!= ( const distribution_type &  dist1, const distribution_type &  dist2  )

friend

Definition at line 70 of file rayleigh_distribution.hpp.

operator<<

template<typename RealType >

template<typename CharT , typename Traits >

std::basic_ostream<CharT, Traits>& operator<< ( std::basic_ostream< CharT, Traits > &  os, const distribution_type &  dist  )

friend

Definition at line 70 of file rayleigh_distribution.hpp.

operator==

template<typename RealType >

bool operator== ( const distribution_type &  dist1, const distribution_type &  dist2  )

friend

Definition at line 70 of file rayleigh_distribution.hpp.

operator>>

template<typename RealType >

template<typename CharT , typename Traits >

std::basic_istream<CharT, Traits>& operator>> ( std::basic_istream< CharT, Traits > &  is, distribution_type &  dist  )

friend

Definition at line 70 of file rayleigh_distribution.hpp.