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

Fisher-F distribution. More...

#include <vsmc/rng/fisher_f_distribution.hpp>

Classes

class  param_type
 

Public Types

using distribution_type = FisherFDistribution< RealType >
 
using result_type = RealType
 

Public Member Functions

 FisherFDistribution (result_type m=1, result_type n=1)
 
 FisherFDistribution (const param_type &param)
 
result_type m () const
 
result_type max () const
 
result_type min () const
 
result_type n () 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)
 
const param_typeparam () const
 
void param (const param_type &param)
 
void pram (param_type &&param)
 
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::FisherFDistribution< RealType >

Fisher-F distribution.

Definition at line 55 of file fisher_f_distribution.hpp.

Member Typedef Documentation

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

Definition at line 57 of file fisher_f_distribution.hpp.

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

Definition at line 57 of file fisher_f_distribution.hpp.

Constructor & Destructor Documentation

template<typename RealType >
vsmc::FisherFDistribution< RealType >::FisherFDistribution ( result_type  m = 1,
result_type  n = 1 
)
inlineexplicit

Definition at line 57 of file fisher_f_distribution.hpp.

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

Definition at line 57 of file fisher_f_distribution.hpp.

Member Function Documentation

template<typename RealType >
result_type vsmc::FisherFDistribution< RealType >::m ( ) const
inline

Definition at line 57 of file fisher_f_distribution.hpp.

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

Definition at line 64 of file fisher_f_distribution.hpp.

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

Definition at line 62 of file fisher_f_distribution.hpp.

template<typename RealType >
result_type vsmc::FisherFDistribution< RealType >::n ( ) const
inline

Definition at line 57 of file fisher_f_distribution.hpp.

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

Definition at line 57 of file fisher_f_distribution.hpp.

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

Definition at line 57 of file fisher_f_distribution.hpp.

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

Definition at line 57 of file fisher_f_distribution.hpp.

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

Definition at line 57 of file fisher_f_distribution.hpp.

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

Definition at line 57 of file fisher_f_distribution.hpp.

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

Definition at line 57 of file fisher_f_distribution.hpp.

template<typename RealType >
void vsmc::FisherFDistribution< RealType >::pram ( param_type &&  param)
inline

Definition at line 57 of file fisher_f_distribution.hpp.

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

Definition at line 66 of file fisher_f_distribution.hpp.

Friends And Related Function Documentation

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

Definition at line 57 of file fisher_f_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 57 of file fisher_f_distribution.hpp.

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

Definition at line 57 of file fisher_f_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 57 of file fisher_f_distribution.hpp.