List of all members | Public Member Functions | Friends
shark::Erlang_distribution< RealType > Class Template Reference

Implements an Erlang distribution. More...

#include <shark/Rng/Erlang.h>

Public Member Functions

 Erlang_distribution (RealType mean=0, RealType variance=1)
 
RealType mean () const
 
RealType variance () const
 
void reset ()
 
template<class Engine >
result_type operator() (Engine &eng)
 

Friends

template<class CharT , class Traits >
std::basic_ostream< CharT, Traits > & operator<< (std::basic_ostream< CharT, Traits > &os, const Erlang_distribution &d)
 
template<class CharT , class Traits >
std::basic_istream< CharT, Traits > & operator>> (std::basic_istream< CharT, Traits > &is, Erlang_distribution &d)
 

Detailed Description

template<class RealType = double>
class shark::Erlang_distribution< RealType >

Implements an Erlang distribution.

Definition at line 50 of file Erlang.h.

Constructor & Destructor Documentation

◆ Erlang_distribution()

template<class RealType = double>
shark::Erlang_distribution< RealType >::Erlang_distribution ( RealType  mean = 0,
RealType  variance = 1 
)
inlineexplicit

Definition at line 56 of file Erlang.h.

References shark::Erlang_distribution< RealType >::mean(), and shark::Erlang_distribution< RealType >::variance().

Member Function Documentation

◆ mean()

template<class RealType = double>
RealType shark::Erlang_distribution< RealType >::mean ( ) const
inline

Definition at line 69 of file Erlang.h.

Referenced by shark::Erlang_distribution< RealType >::Erlang_distribution(), shark::Erlang< RngType >::p(), and shark::Erlang< RngType >::variance().

◆ operator()()

template<class RealType = double>
template<class Engine >
result_type shark::Erlang_distribution< RealType >::operator() ( Engine &  eng)
inline

Definition at line 81 of file Erlang.h.

References remora::prod(), and shark::uni().

◆ reset()

template<class RealType = double>
void shark::Erlang_distribution< RealType >::reset ( )
inline

Definition at line 78 of file Erlang.h.

◆ variance()

template<class RealType = double>
RealType shark::Erlang_distribution< RealType >::variance ( ) const
inline

Definition at line 73 of file Erlang.h.

Referenced by shark::Erlang_distribution< RealType >::Erlang_distribution(), and shark::Erlang< RngType >::p().

Friends And Related Function Documentation

◆ operator<<

template<class RealType = double>
template<class CharT , class Traits >
std::basic_ostream<CharT,Traits>& operator<< ( std::basic_ostream< CharT, Traits > &  os,
const Erlang_distribution< RealType > &  d 
)
friend

Definition at line 101 of file Erlang.h.

◆ operator>>

template<class RealType = double>
template<class CharT , class Traits >
std::basic_istream<CharT,Traits>& operator>> ( std::basic_istream< CharT, Traits > &  is,
Erlang_distribution< RealType > &  d 
)
friend

Definition at line 111 of file Erlang.h.

The documentation for this class was generated from the following file: