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

Exponential distribution. More...

#include <vsmc/rng/exponential_distribution.hpp>

Classes

class  param_type
 

Public Types

using distribution_type = ExponentialDistribution< RealType >
 
using result_type = RealType
 

Public Member Functions

 ExponentialDistribution (result_type lambda=1)
 
 ExponentialDistribution (const param_type &param)
 
result_type lambda () const
 
result_type max () const
 
result_type min () const
 
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 >
void operator() (RNGType &rng, std::size_t n, result_type *r)
 
template<typename RNGType >
result_type operator() (RNGType &rng)
 
param_type param () const
 
void param (const param_type &parm)
 
void reset ()
 

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::ExponentialDistribution< RealType >

Exponential distribution.

Definition at line 55 of file exponential_distribution.hpp.

Member Typedef Documentation

template<typename RealType>
using vsmc::ExponentialDistribution< RealType >::distribution_type = ExponentialDistribution< RealType >

Definition at line 58 of file exponential_distribution.hpp.

template<typename RealType>
using vsmc::ExponentialDistribution< RealType >::result_type = RealType

Definition at line 58 of file exponential_distribution.hpp.

Constructor & Destructor Documentation

template<typename RealType>
vsmc::ExponentialDistribution< RealType >::ExponentialDistribution ( result_type  lambda = 1)
inlineexplicit

Definition at line 58 of file exponential_distribution.hpp.

template<typename RealType>
vsmc::ExponentialDistribution< RealType >::ExponentialDistribution ( const param_type param)
inlineexplicit

Definition at line 58 of file exponential_distribution.hpp.

Member Function Documentation

template<typename RealType>
result_type vsmc::ExponentialDistribution< RealType >::lambda ( ) const
inline

Definition at line 58 of file exponential_distribution.hpp.

template<typename RealType>
result_type vsmc::ExponentialDistribution< RealType >::max ( ) const
inline

Definition at line 64 of file exponential_distribution.hpp.

template<typename RealType>
result_type vsmc::ExponentialDistribution< RealType >::min ( ) const
inline

Definition at line 62 of file exponential_distribution.hpp.

template<typename RealType>
template<typename RNGType >
result_type vsmc::ExponentialDistribution< RealType >::operator() ( RNGType &  rng)
inline

Definition at line 58 of file exponential_distribution.hpp.

template<typename RealType>
template<typename RNGType >
void vsmc::ExponentialDistribution< RealType >::operator() ( RNGType &  rng,
std::size_t  n,
result_type r,
const param_type param 
)
inline

Definition at line 58 of file exponential_distribution.hpp.

template<typename RealType>
template<typename RNGType >
result_type vsmc::ExponentialDistribution< RealType >::operator() ( RNGType &  rng,
const param_type param 
)
inline

Definition at line 58 of file exponential_distribution.hpp.

template<typename RealType>
template<typename RNGType >
void vsmc::ExponentialDistribution< RealType >::operator() ( RNGType &  rng,
std::size_t  n,
result_type r 
)
inline

Definition at line 58 of file exponential_distribution.hpp.

template<typename RealType>
param_type vsmc::ExponentialDistribution< RealType >::param ( ) const
inline

Definition at line 58 of file exponential_distribution.hpp.

template<typename RealType>
void vsmc::ExponentialDistribution< RealType >::param ( const param_type parm)
inline

Definition at line 58 of file exponential_distribution.hpp.

template<typename RealType>
void vsmc::ExponentialDistribution< RealType >::reset ( )
inline

Definition at line 69 of file exponential_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 exponential_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 exponential_distribution.hpp.

template<typename RealType>
bool operator== ( const distribution_type dist1,
const distribution_type dist2 
)
friend

Definition at line 59 of file exponential_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 exponential_distribution.hpp.