Discrete geometric distribution. More...
#include <Random.h>
Public Member Functions | |
| Geometric (RNG *gen, Double probability=0.5) | |
| Construct a random number generator for a geometric uniform distribution. More... | |
| virtual | ~Geometric () |
| The destructor is trivial. More... | |
| virtual Double | operator() () |
| Returns a value from the geometric uniform distribution. More... | |
| uInt | asInt () |
| Double | probability () const |
| Functions that allow you to query and change the parameters of the geometric uniform distribution. More... | |
| void | probability (Double x) |
| virtual void | setParameters (const Vector< Double > &parms) |
| These function allow you to manipulate the parameter (probability) 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 Attributes | |
| Double | itsProbability |
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
Discrete geometric distribution.
Synopsis
The Geometric class implements a discrete geometric distribution. The probability is the only parameter. The operator() functions returns an non-negative integral value indicating the number of uniform random samples actually drawn before one is obtained that is larger than the given probability. To get this same value as an integer use the asInt function.
It is assumed that the probability is between zero and one (0 <= probability < 1) and and AipsError exception thrown if this is not true. The remaining function 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
◆ Geometric()
Construct a random number generator for a geometric uniform 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 argument defines the range of possible return values for this distribution as described in the synopsis.
◆ ~Geometric()
|
virtual |
The destructor is trivial.
Member Function Documentation
◆ asInt()
| uInt casacore::Geometric::asInt | ( | ) |
◆ checkParameters()
Implements casacore::Random.
◆ operator()()
|
virtual |
Returns a value from the geometric uniform distribution.
The returned value is a non-negative integer and using the asInt function bypasses the conversion to a floating point number.
Implements casacore::Random.
◆ parameters()
Implements casacore::Random.
◆ probability() [1/2]
|
inline |
Functions that allow you to query and change the parameters of the geometric uniform distribution.
Definition at line 875 of file Random.h.
References itsProbability.
◆ probability() [2/2]
| void casacore::Geometric::probability | ( | Double | x | ) |
◆ setParameters()
These function allow you to manipulate the parameter (probability) described above through the base class.
The Vectors must always be of length one.
Implements casacore::Random.
Member Data Documentation
◆ itsProbability
|
private |
Definition at line 872 of file Random.h.
Referenced by probability().
The documentation for this class was generated from the following file:
- casa/BasicMath/Random.h
