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. More...
virtual	~NegativeExpntl ()
	The destructor is trivial. More...
virtual Double	operator() ()
	Returns a value from the negative exponential distribution. More...
Double	mean () const
	Functions that allow you to query and change the parameters of the negative exponential distribution. More...
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. 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	itsMean

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

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.

Member Function Documentation

virtual Bool casacore::NegativeExpntl::checkParameters ( const Vector< Double > &  parms ) const

virtual

Implements casacore::Random.

Double casacore::NegativeExpntl::mean ( ) const

inline

Functions that allow you to query and change the parameters of the negative exponential distribution.

Definition at line 1174 of file Random.h.

References itsMean.

void casacore::NegativeExpntl::mean

(

Double

x

)

virtual Double casacore::NegativeExpntl::operator() ( )

virtual

Returns a value from the negative exponential distribution.

Implements casacore::Random.

virtual Vector<Double> casacore::NegativeExpntl::parameters ( ) const

virtual

Implements casacore::Random.

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

Member Data Documentation

Double casacore::NegativeExpntl::itsMean

private

Definition at line 1171 of file Random.h.

Referenced by mean().

---

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

• casa/casacore/casa/BasicMath/Random.h