vsmc::RayleighDistribution< RealType > Class Template Reference

Rayleigh distribution. More...

#include <vsmc/rng/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)
result_type	max () const
result_type	min () const
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)
template<typename RNGType >
result_type	operator() (RNGType &rng, const param_type &param)
template<typename RNGType >
result_type	operator() (RNGType &rng)
void	param (const param_type &parm)
param_type	param () const
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 vsmc::RayleighDistribution< RealType >

Rayleigh distribution.

Definition at line 506 of file common.hpp.

Member Typedef Documentation

template<typename RealType>

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

Definition at line 58 of file rayleigh_distribution.hpp.

template<typename RealType>

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

Definition at line 58 of file rayleigh_distribution.hpp.

Constructor & Destructor Documentation

template<typename RealType>

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

inlineexplicit

Definition at line 58 of file rayleigh_distribution.hpp.

template<typename RealType>

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

inlineexplicit

Definition at line 58 of file rayleigh_distribution.hpp.

Member Function Documentation

template<typename RealType>

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

inline

Definition at line 64 of file rayleigh_distribution.hpp.

template<typename RealType>

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

inline

Definition at line 62 of file rayleigh_distribution.hpp.

template<typename RealType>

template<typename RNGType >

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

inline

Definition at line 58 of file rayleigh_distribution.hpp.

template<typename RealType>

template<typename RNGType >

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

inline

Definition at line 58 of file rayleigh_distribution.hpp.

template<typename RealType>

template<typename RNGType >

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

inline

Definition at line 58 of file rayleigh_distribution.hpp.

template<typename RealType>

template<typename RNGType >

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

inline

Definition at line 58 of file rayleigh_distribution.hpp.

template<typename RealType>

param_type vsmc::RayleighDistribution< RealType >::param ( ) const

inline

Definition at line 58 of file rayleigh_distribution.hpp.

template<typename RealType>

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

inline

Definition at line 58 of file rayleigh_distribution.hpp.

template<typename RealType>

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

inline

Definition at line 69 of file rayleigh_distribution.hpp.

template<typename RealType>

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

inline

Definition at line 58 of file rayleigh_distribution.hpp.

Friends And Related Function Documentation

template<typename RealType>

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

friend

Definition at line 59 of file rayleigh_distribution.hpp.

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 59 of file rayleigh_distribution.hpp.

template<typename RealType>

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

friend

Definition at line 59 of file rayleigh_distribution.hpp.

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 59 of file rayleigh_distribution.hpp.