casacore::Erlang Class Reference

Erlang distribution. More...

#include <Random.h>

Inheritance diagram for casacore::Erlang:

List of all members.

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

---

Detailed Description

Erlang distribution.

Synopsis

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.

Example

Thrown Exceptions

• AipsError: if bad values for the arguments are given, as specified above.

To Do

• Nothing I hope!

Definition at line 739 of file Random.h.

---

Constructor & Destructor Documentation

casacore::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 casacore::Erlang::~Erlang

(

)

[virtual]

The destructor is trivial.

---

Member Function Documentation

virtual Bool casacore::Erlang::checkParameters

(

const Vector< Double > &

parms

)

const [virtual]

Implements casacore::Random.

void casacore::Erlang::mean

(

Double

x

)

[inline]

Definition at line 792 of file Random.h.

References itsMean, and setState().

Double casacore::Erlang::mean

(

)

const [inline]

Functions that allow you to query and change the parameters of the discrete uniform distribution.

Definition at line 788 of file Random.h.

References itsMean.

virtual Double casacore::Erlang::operator()

(

)

[virtual]

Returns a value from the Erlang distribution.

Implements casacore::Random.

virtual Vector<Double> casacore::Erlang::parameters

(

)

const [virtual]

Implements casacore::Random.

virtual void casacore::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 casacore::Random.

void casacore::Erlang::setState

(

)

[private]

Referenced by Erlang(), mean(), and variance().

void casacore::Erlang::variance

(

Double

x

)

[inline]

Definition at line 801 of file Random.h.

References itsVariance, and setState().

Double casacore::Erlang::variance

(

)

const [inline]

Definition at line 797 of file Random.h.

References itsVariance.

---

Member Data Documentation

Double casacore::Erlang::itsA [private]

Definition at line 777 of file Random.h.

Int casacore::Erlang::itsK [private]

Definition at line 776 of file Random.h.

Double casacore::Erlang::itsMean [private]

Definition at line 774 of file Random.h.

Referenced by mean().

Double casacore::Erlang::itsVariance [private]

Definition at line 775 of file Random.h.

Referenced by variance().

---

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

• casacore/casa/BasicMath/Random.h