shark::HyperGeometric< RngType > Class Template Reference

Random variable with a hypergeometric distribution. More...

#include <shark/Rng/HyperGeometric.h>

Inheritance diagram for shark::HyperGeometric< RngType >:

Public Member Functions
	HyperGeometric (RngType &rng, double k=1, double theta=1)
double	operator() (double k, double theta)
double	mean () const
double	variance () const
void	mean (double newMean)
void	variance (double newVariance)
double	p (double x) const

Detailed Description

template<typename RngType = shark::DefaultRngType>
class shark::HyperGeometric< RngType >

Random variable with a hypergeometric distribution.

Definition at line 118 of file HyperGeometric.h.

Constructor & Destructor Documentation

HyperGeometric()

template<typename RngType = shark::DefaultRngType>

shark::HyperGeometric< RngType >::HyperGeometric ( RngType &  rng, double  k = 1, double  theta = 1  )

inline

Definition at line 123 of file HyperGeometric.h.

Member Function Documentation

mean() [1/2]

template<typename RngType = shark::DefaultRngType>

double shark::HyperGeometric< RngType >::mean ( ) const

inline

Definition at line 135 of file HyperGeometric.h.

mean() [2/2]

template<typename RngType = shark::DefaultRngType>

void shark::HyperGeometric< RngType >::mean ( double  newMean )

inline

Definition at line 143 of file HyperGeometric.h.

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

operator()()

template<typename RngType = shark::DefaultRngType>

double shark::HyperGeometric< RngType >::operator() ( double  k, double  theta  )

inline

Definition at line 129 of file HyperGeometric.h.

p()

template<typename RngType = shark::DefaultRngType>

double shark::HyperGeometric< RngType >::p ( double  x ) const

inline

!!!

Definition at line 152 of file HyperGeometric.h.

variance() [1/2]

template<typename RngType = shark::DefaultRngType>

double shark::HyperGeometric< RngType >::variance ( ) const

inline

Definition at line 139 of file HyperGeometric.h.

variance() [2/2]

template<typename RngType = shark::DefaultRngType>

void shark::HyperGeometric< RngType >::variance ( double  newVariance )

inline

Definition at line 147 of file HyperGeometric.h.

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

---

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

• include/shark/Rng/HyperGeometric.h