Hypergeometric distribution. More...
#include <Random.h>
Public Member Functions | |
| HyperGeometric (RNG *gen, Double mean=0.5, Double variance=1.0) | |
| Construct a random number generator for an hypergeometric distribution. More... | |
| virtual | ~HyperGeometric () |
| The destructor is trivial. More... | |
| virtual Double | operator() () |
| Returns a value from the hypergeometric distribution. More... | |
| Double | mean () const |
| Functions that allow you to query and change the parameters of the hypergeometric distribution. More... | |
| void | mean (Double x) |
| Double | variance () const |
| void | variance (Double x) |
| virtual void | setParameters (const Vector< Double > &parms) |
| These function allow you to manipulate the parameters (mean & variance) described above through the base class. More... | |
| virtual Vector< Double > | parameters () const |
| virtual Bool | checkParameters (const Vector< Double > &parms) const |
 Public Member Functions inherited from casacore::Random | |
| virtual | ~Random () |
| A virtual destructor is needed to ensure that the destructor of derived classes gets used. More... | |
| RNG * | generator () |
| Functions that allow you to access and change the class that generates the random bits. More... | |
| void | generator (RNG *p) |
Private Member Functions | |
| void | setState () |
Private Attributes | |
| Double | itsMean |
| Double | itsVariance |
| Double | itsP |
Additional Inherited Members | |
| Public Types inherited from casacore::Random | |
| enum | Types { BINOMIAL , DISCRETEUNIFORM , ERLANG , GEOMETRIC , HYPERGEOMETRIC , NORMAL , LOGNORMAL , NEGATIVEEXPONENTIAL , POISSON , UNIFORM , WEIBULL , UNKNOWN , NUMBER_TYPES } |
| This enumerator lists all the predefined random number distributions. More... | |
| Static Public Member Functions inherited from casacore::Random | |
| static String | asString (Random::Types type) |
| Convert the enumerator to a lower-case string. More... | |
| static Random::Types | asType (const String &str) |
| Convert the string to enumerator. More... | |
| static Random * | construct (Random::Types type, RNG *gen) |
| Convert the Random::Type enumerator to a specific object (derived from Random but upcast to a Random object). More... | |
| static Vector< Double > | defaultParameters (Random::Types type) |
| returns the default parameters for the specified distribution. More... | |
| Protected Member Functions inherited from casacore::Random | |
| Random (RNG *generator) | |
| Protected Attributes inherited from casacore::Random | |
| RNG * | itsRNG |
Detailed Description
Hypergeometric distribution.
Synopsis
The HyperGeometric class implements the hypergeometric distribution. The mean and variance are the parameters of the distribution. The operator() functions returns a value from this distribution
It is assumed the variance is positive and that the mean is non-zero and not bigger than the square-root of the variance. An AipsError exception is thrown if this is not true. The remaining members allow you to read and set the parameters.
Example
Thrown Exceptions
- AipsError: if bad values for the arguments are given, as specified above.
To Do
- Nothing I hope!
Constructor & Destructor Documentation
◆ HyperGeometric()
|
inline |
Construct a random number generator for an hypergeometric distribution.
The first argument is a class that produces random bits. This pointer is NOT taken over by this class and the user is responsible for deleting it. The second and third arguments define the parameters for this distribution as described in the synopsis.
Definition at line 946 of file Random.h.
References setState().
◆ ~HyperGeometric()
|
virtual |
The destructor is trivial.
Member Function Documentation
◆ checkParameters()
|
virtual |
Implements casacore::Random.
◆ mean() [1/2]
|
inline |
◆ mean() [2/2]
|
inline |
Definition at line 958 of file Random.h.
References itsMean, and setState().
◆ operator()()
|
virtual |
Returns a value from the hypergeometric distribution.
Implements casacore::Random.
◆ parameters()
Implements casacore::Random.
◆ setParameters()
These function allow you to manipulate the parameters (mean & variance) described above through the base class.
The Vectors must always be of length two.
Implements casacore::Random.
◆ setState()
|
private |
Referenced by HyperGeometric(), mean(), and variance().
◆ variance() [1/2]
|
inline |
Definition at line 963 of file Random.h.
References itsVariance.
◆ variance() [2/2]
|
inline |
Definition at line 967 of file Random.h.
References itsVariance, and setState().
Member Data Documentation
◆ itsMean
|
private |
◆ itsP
◆ itsVariance
|
private |
Definition at line 941 of file Random.h.
Referenced by variance().
The documentation for this class was generated from the following file:
- casa/BasicMath/Random.h
