|
casa
$Rev:20696$
|
|
casa
$Rev:20696$
|
#include <Random.h>
Public Member Functions | |
| Poisson (RNG *gen, Double mean=0.0) | |
| Construct a random number generator for a Poisson distribution. | |
| virtual | ~Poisson () |
| The destructor is trivial. | |
| virtual Double | operator() () |
| Returns a value from the Poisson distribution. | |
| uInt | asInt () |
| Double | mean () const |
| Functions that allow you to query and change the parameters of the Poisson distribution. | |
| void | mean (Double x) |
| virtual void | setParameters (const Vector< Double > &parms) |
| These function allow you to manipulate the parameters (mean) described above through the base class. | |
| virtual Vector< Double > | parameters () const |
| virtual Bool | checkParameters (const Vector< Double > &parms) const |
Private Attributes | |
| Double | itsMean |
Poisson distribution.
The Poisson class implements a Poisson distribution. The mean parameter, is the only parameter of this distribution. The operator() functions returns a value from this distribution. The remaining members allow you to inspect and change the mean. It is assumed that the supplied mean is non-negative and an AipsError exception is thrown if this is not true. The remaining members allow you to read and set the parameters.
| casa::Poisson::Poisson | ( | RNG * | gen, |
| Double | mean = 0.0 |
||
| ) |
Construct a random number generator for a Poisson 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 parameters for this distribution as described in the synopsis.
| virtual casa::Poisson::~Poisson | ( | ) | [virtual] |
The destructor is trivial.
| virtual Bool casa::Poisson::checkParameters | ( | const Vector< Double > & | parms | ) | const [virtual] |
Implements casa::Random.
| Double casa::Poisson::mean | ( | ) | const [inline] |
| void casa::Poisson::mean | ( | Double | x | ) |
| virtual Double casa::Poisson::operator() | ( | ) | [virtual] |
Returns a value from the Poisson distribution.
The returned value is a non-negative integer and using the asInt function bypasses the conversion to a floating point number.
Implements casa::Random.
| virtual Vector<Double> casa::Poisson::parameters | ( | ) | const [virtual] |
Implements casa::Random.
| virtual void casa::Poisson::setParameters | ( | const Vector< Double > & | parms | ) | [virtual] |
These function allow you to manipulate the parameters (mean) described above through the base class.
The Vectors must always be of length one.
Implements casa::Random.
Double casa::Poisson::itsMean [private] |
1.8.0
