vSMC
vSMC: Scalable Monte Carlo
Classes | Public Types | Public Member Functions | Friends | List of all members
vsmc::StableDistribution< FPType > Class Template Reference

Stable distribution. More...

#include <vsmc/rng/stable_distribution.hpp>

Classes

struct  param_type
 

Public Types

typedef FPType result_type
 

Public Member Functions

 StableDistribution (result_type stability=1, result_type skewness=0, result_type location=0, result_type scale=1)
 
 StableDistribution (const param_type &param)
 
result_type location () const
 
result_type max () const
 
result_type min () const
 
template<typename Eng >
result_type operator() (Eng &eng) const
 
param_type param () const
 
void param (const param_type &param)
 
void reset () const
 
result_type scale () const
 
result_type skewness () const
 
result_type stability () const
 

Friends

bool operator!= (const StableDistribution< FPType > &rstable1, const StableDistribution< FPType > &rstable2)
 
template<typename CharT , typename Traits >
std::basic_ostream< CharT, Traits > & operator<< (std::basic_ostream< CharT, Traits > &os, const StableDistribution< FPType > &rstable)
 
bool operator== (const StableDistribution< FPType > &rstable1, const StableDistribution< FPType > &rstable2)
 
template<typename CharT , typename Traits >
std::basic_istream< CharT, Traits > & operator>> (std::basic_istream< CharT, Traits > &is, StableDistribution< FPType > &rstable)
 

Detailed Description

template<typename FPType>
class vsmc::StableDistribution< FPType >

Stable distribution.

Definition at line 57 of file stable_distribution.hpp.

Member Typedef Documentation

template<typename FPType>
typedef FPType vsmc::StableDistribution< FPType >::result_type

Definition at line 63 of file stable_distribution.hpp.

Constructor & Destructor Documentation

template<typename FPType>
vsmc::StableDistribution< FPType >::StableDistribution ( result_type  stability = 1,
result_type  skewness = 0,
result_type  location = 0,
result_type  scale = 1 
)
inlineexplicit

Definition at line 156 of file stable_distribution.hpp.

template<typename FPType>
vsmc::StableDistribution< FPType >::StableDistribution ( const param_type param)
inlineexplicit

Definition at line 172 of file stable_distribution.hpp.

Member Function Documentation

template<typename FPType>
result_type vsmc::StableDistribution< FPType >::location ( ) const
inline

Definition at line 202 of file stable_distribution.hpp.

template<typename FPType>
result_type vsmc::StableDistribution< FPType >::max ( ) const
inline

Definition at line 206 of file stable_distribution.hpp.

template<typename FPType>
result_type vsmc::StableDistribution< FPType >::min ( ) const
inline

Definition at line 204 of file stable_distribution.hpp.

template<typename FPType>
template<typename Eng >
result_type vsmc::StableDistribution< FPType >::operator() ( Eng &  eng) const
inline

Definition at line 210 of file stable_distribution.hpp.

template<typename FPType>
param_type vsmc::StableDistribution< FPType >::param ( ) const
inline

Definition at line 186 of file stable_distribution.hpp.

template<typename FPType>
void vsmc::StableDistribution< FPType >::param ( const param_type param)
inline

Definition at line 189 of file stable_distribution.hpp.

template<typename FPType>
void vsmc::StableDistribution< FPType >::reset ( ) const
inline

Definition at line 198 of file stable_distribution.hpp.

template<typename FPType>
result_type vsmc::StableDistribution< FPType >::scale ( ) const
inline

Definition at line 203 of file stable_distribution.hpp.

template<typename FPType>
result_type vsmc::StableDistribution< FPType >::skewness ( ) const
inline

Definition at line 201 of file stable_distribution.hpp.

template<typename FPType>
result_type vsmc::StableDistribution< FPType >::stability ( ) const
inline

Definition at line 200 of file stable_distribution.hpp.

Friends And Related Function Documentation

template<typename FPType>
bool operator!= ( const StableDistribution< FPType > &  rstable1,
const StableDistribution< FPType > &  rstable2 
)
friend

Definition at line 237 of file stable_distribution.hpp.

template<typename FPType>
template<typename CharT , typename Traits >
std::basic_ostream<CharT, Traits>& operator<< ( std::basic_ostream< CharT, Traits > &  os,
const StableDistribution< FPType > &  rstable 
)
friend

Definition at line 243 of file stable_distribution.hpp.

template<typename FPType>
bool operator== ( const StableDistribution< FPType > &  rstable1,
const StableDistribution< FPType > &  rstable2 
)
friend

Definition at line 218 of file stable_distribution.hpp.

template<typename FPType>
template<typename CharT , typename Traits >
std::basic_istream<CharT, Traits>& operator>> ( std::basic_istream< CharT, Traits > &  is,
StableDistribution< FPType > &  rstable 
)
friend

Definition at line 257 of file stable_distribution.hpp.