casacore::NegativeExpntl Class Reference

Negative exponential distribution. More...

#include <Random.h>

Inheritance diagram for casacore::NegativeExpntl:

Public Member Functions
	NegativeExpntl (RNG *gen, Double mean=1.0)
	Construct a random number generator for a negative exponential distribution.
virtual	~NegativeExpntl ()
	The destructor is trivial.
virtual Double	operator() ()
	Returns a value from the negative exponential distribution.
Double	mean () const
	Functions that allow you to query and change the parameters of the negative exponential 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

Detailed Description

Negative exponential distribution.

Synopsis

The NegativeExpntl class implements a negative exponential 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.

Example

Thrown Exceptions

No exceptions are thrown by this class.

To Do

Nothing I hope!

Definition at line 1139 of file Random.h.

Constructor & Destructor Documentation

casacore::NegativeExpntl::NegativeExpntl	(	RNG *	gen,
		Double	mean = `1.0`
	)

Construct a random number generator for a negative exponential 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 casacore::NegativeExpntl::~NegativeExpntl ( ) [virtual]

The destructor is trivial.