casa
$Rev:20696$
|
#include <Random.h>
Public Member Functions | |
Erlang (RNG *gen, Double mean=1.0, Double variance=1.0) | |
Construct a random number generator for an Erlang distribution. | |
virtual | ~Erlang () |
The destructor is trivial. | |
virtual Double | operator() () |
Returns a value from the Erlang distribution. | |
Double | mean () const |
Functions that allow you to query and change the parameters of the discrete uniform distribution. | |
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. | |
virtual Vector< Double > | parameters () const |
virtual Bool | checkParameters (const Vector< Double > &parms) const |
Private Member Functions | |
void | setState () |
Private Attributes | |
Double | itsMean |
Double | itsVariance |
Int | itsK |
Double | itsA |
Erlang distribution.
The Erlang
class implements an Erlang distribution with mean mean
and variance variance
.
It is assumed that the mean is non-zero and the variance is positive an AipsError exception thrown if this is not true. The remaining members allow you to read and set the parameters.
casa::Erlang::Erlang | ( | RNG * | gen, |
Double | mean = 1.0 , |
||
Double | variance = 1.0 |
||
) | [inline] |
Construct a random number generator for an Erlang 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 780 of file Random.h.
References setState().
virtual casa::Erlang::~Erlang | ( | ) | [virtual] |
The destructor is trivial.
virtual Bool casa::Erlang::checkParameters | ( | const Vector< Double > & | parms | ) | const [virtual] |
Implements casa::Random.
Double casa::Erlang::mean | ( | ) | const [inline] |
void casa::Erlang::mean | ( | Double | x | ) | [inline] |
Definition at line 792 of file Random.h.
References itsMean, and setState().
virtual Double casa::Erlang::operator() | ( | ) | [virtual] |
Returns a value from the Erlang distribution.
Implements casa::Random.
virtual Vector<Double> casa::Erlang::parameters | ( | ) | const [virtual] |
Implements casa::Random.
virtual void casa::Erlang::setParameters | ( | const Vector< Double > & | parms | ) | [virtual] |
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 casa::Random.
void casa::Erlang::setState | ( | ) | [private] |
Referenced by Erlang(), mean(), and variance().
Double casa::Erlang::variance | ( | ) | const [inline] |
Definition at line 797 of file Random.h.
References itsVariance.
void casa::Erlang::variance | ( | Double | x | ) | [inline] |
Definition at line 801 of file Random.h.
References itsVariance, and setState().
Double casa::Erlang::itsA [private] |
Int casa::Erlang::itsK [private] |
Double casa::Erlang::itsMean [private] |
Double casa::Erlang::itsVariance [private] |
Definition at line 775 of file Random.h.
Referenced by variance().