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

boost random suitable distribution for an truncated exponential. See TruncatedExponential for more details. More...

#include <shark/Rng/TruncatedExponential.h>

Public Member Functions

 TruncatedExponential_distribution (RealType lambda, RealType max)
 
 TruncatedExponential_distribution (RealType lambda, RealType max, RealType integral)
 
RealType max () const
 
RealType lambda () const
 
RealType integral () const
 
void reset ()
 
template<class Engine >
result_type operator() (Engine &eng)
 

Friends

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

Detailed Description

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

boost random suitable distribution for an truncated exponential. See TruncatedExponential for more details.

Definition at line 48 of file TruncatedExponential.h.

Constructor & Destructor Documentation

◆ TruncatedExponential_distribution() [1/2]

template<class RealType = double>
shark::TruncatedExponential_distribution< RealType >::TruncatedExponential_distribution ( RealType  lambda,
RealType  max 
)
inlineexplicit

Definition at line 53 of file TruncatedExponential.h.

◆ TruncatedExponential_distribution() [2/2]

template<class RealType = double>
shark::TruncatedExponential_distribution< RealType >::TruncatedExponential_distribution ( RealType  lambda,
RealType  max,
RealType  integral 
)
inlineexplicit

Definition at line 56 of file TruncatedExponential.h.

Member Function Documentation

◆ integral()

template<class RealType = double>
RealType shark::TruncatedExponential_distribution< RealType >::integral ( ) const
inline

Definition at line 68 of file TruncatedExponential.h.

◆ lambda()

template<class RealType = double>
RealType shark::TruncatedExponential_distribution< RealType >::lambda ( ) const
inline

Definition at line 64 of file TruncatedExponential.h.

Referenced by shark::TruncatedExponential< RngType >::p(), and shark::TruncatedExponential< RngType >::setMax().

◆ max()

template<class RealType = double>
RealType shark::TruncatedExponential_distribution< RealType >::max ( ) const
inline

Definition at line 60 of file TruncatedExponential.h.

Referenced by shark::TruncatedExponential< RngType >::operator()(), shark::TruncatedExponential< RngType >::p(), and shark::TruncatedExponential< RngType >::setLambda().

◆ operator()()

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

Definition at line 75 of file TruncatedExponential.h.

◆ reset()

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

Definition at line 72 of file TruncatedExponential.h.

Friends And Related Function Documentation

◆ operator<<

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

Definition at line 86 of file TruncatedExponential.h.

◆ operator>>

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

Definition at line 94 of file TruncatedExponential.h.

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