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

Hypergeometric distribution. More...

#include <shark/Rng/HyperGeometric.h>

Public Member Functions

 HyperGeometric_distribution (RealType mean, RealType variance)
 
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 HyperGeometric_distribution &d)
 
template<class CharT , class Traits >
std::basic_istream< CharT, Traits > & operator>> (std::basic_istream< CharT, Traits > &is, HyperGeometric_distribution &d)
 

Detailed Description

template<class IntType = int, class RealType = double>
class shark::HyperGeometric_distribution< IntType, RealType >

Hypergeometric distribution.

Definition at line 48 of file HyperGeometric.h.

Constructor & Destructor Documentation

◆ HyperGeometric_distribution()

template<class IntType = int, class RealType = double>
shark::HyperGeometric_distribution< IntType, RealType >::HyperGeometric_distribution ( RealType  mean,
RealType  variance 
)
inlineexplicit

Definition at line 54 of file HyperGeometric.h.

References shark::HyperGeometric_distribution< IntType, RealType >::mean().

Member Function Documentation

◆ mean()

template<class IntType = int, class RealType = double>
RealType shark::HyperGeometric_distribution< IntType, RealType >::mean ( ) const
inline

Definition at line 70 of file HyperGeometric.h.

Referenced by shark::HyperGeometric_distribution< IntType, RealType >::HyperGeometric_distribution(), and shark::HyperGeometric< RngType >::variance().

◆ operator()()

template<class IntType = int, class RealType = double>
template<class Engine >
result_type shark::HyperGeometric_distribution< IntType, RealType >::operator() ( Engine &  eng)
inline

Definition at line 82 of file HyperGeometric.h.

◆ reset()

template<class IntType = int, class RealType = double>
void shark::HyperGeometric_distribution< IntType, RealType >::reset ( )
inline

Definition at line 79 of file HyperGeometric.h.

◆ variance()

template<class IntType = int, class RealType = double>
RealType shark::HyperGeometric_distribution< IntType, RealType >::variance ( ) const
inline

Definition at line 74 of file HyperGeometric.h.

Referenced by shark::HyperGeometric< RngType >::mean().

Friends And Related Function Documentation

◆ operator<<

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

Definition at line 92 of file HyperGeometric.h.

◆ operator>>

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

Definition at line 101 of file HyperGeometric.h.

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