Normal or Gaussian distribution. More...

#include <Random.h>

Inheritance diagram for casacore::Normal:

Public Member Functions
	Normal (RNG *gen, Double mean=0.0, Double variance=1.0)
	Construct a random number generator for a normal distribution. More...

virtual	~Normal ()
	The destructor is trivial. More...

virtual Double	operator() ()
	Returns a value from the normal distribution. More...

virtual Double	mean () const
	Functions that allow you to query and change the parameters of the normal distribution. More...

virtual void	mean (Double x)

virtual Double	variance () const

virtual 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. 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

Double	itsVariance

Double	itsStdDev

Bool	itsCached

Double	itsCachedValue

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

Normal or Gaussian distribution.

Synopsis

The Normal class implements the normal or Gaussian distribution. The mean and variance are the parameters of the distribution. The operator() functions returns a value from this distribution

It is assumed that the supplied variance is positive and an AipsError exception is thrown if this is not true. The remaining members allow you to read and set the parameters. The LogNormal class is derived from this one.

Example

Thrown Exceptions

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

To Do

Nothing I hope!

Definition at line 997 of file Random.h.

Constructor & Destructor Documentation

casacore::Normal::Normal	(	RNG *	gen,
		Double	mean = `0.0`,
		Double	variance = `1.0`
	)

Construct a random number generator for a normal 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.

virtual casacore::Normal::~Normal ( )

virtual

The destructor is trivial.