casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Static Private Member Functions | Private Attributes
casa::Uniform Class Reference

Uniform distribution. More...

#include <Random.h>

Inheritance diagram for casa::Uniform:
casa::Random

List of all members.

Public Member Functions

 Uniform (RNG *gen, Double low=-1.0, Double high=1.0)
 Construct a random number generator for a uniform distribution.
virtual ~Uniform ()
 The destructor is trivial.
virtual Double operator() ()
 Returns a value from the uniform distribution.
Double low () const
 Functions that allow you to query and change the parameters of the uniform distribution.
void low (Double x)
Double high () const
void high (Double x)
void range (Double low, Double high)
virtual void setParameters (const Vector< Double > &parms)
 These function allow you to manipulate the parameters (low & high) described above through the base class.
virtual Vector< Doubleparameters () const
virtual Bool checkParameters (const Vector< Double > &parms) const

Static Private Member Functions

static Double calcDelta (Double low, Double high)
 
   

Private Attributes

Double itsLow
Double itsHigh
Double itsDelta

Detailed Description

Uniform distribution.

Synopsis

The Uniform class implements a uniform random variable over the copen interval ranging from [low..high). The low parameter is the lowest possible return value and the high parameter can never be returned. The operator() functions returns a value from this distribution.

It is assumed that low limit is less than the high limit and an AipsError exception is thrown if this is not true. The remaining members allow you to read and set the parameters.

Example

Thrown Exceptions

To Do

Definition at line 1272 of file Random.h.


Constructor & Destructor Documentation

casa::Uniform::Uniform ( RNG gen,
Double  low = -1.0,
Double  high = 1.0 
)

Construct a random number generator for a uniform 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 remaining arguments define the parameters for this distribution as described in the synopsis.

virtual casa::Uniform::~Uniform ( ) [virtual]

The destructor is trivial.


Member Function Documentation

static Double casa::Uniform::calcDelta ( Double  low,
Double  high 
) [static, private]

   

virtual Bool casa::Uniform::checkParameters ( const Vector< Double > &  parms) const [virtual]

Implements casa::Random.

Double casa::Uniform::high ( ) const [inline]

Definition at line 1317 of file Random.h.

References itsHigh.

Double casa::Uniform::low ( ) const [inline]

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

Definition at line 1313 of file Random.h.

References itsLow.

virtual Double casa::Uniform::operator() ( ) [virtual]

Returns a value from the uniform distribution.

Implements casa::Random.

virtual Vector<Double> casa::Uniform::parameters ( ) const [virtual]

Implements casa::Random.

void casa::Uniform::range ( Double  low,
Double  high 
)
virtual void casa::Uniform::setParameters ( const Vector< Double > &  parms) [virtual]

These function allow you to manipulate the parameters (low & high) described above through the base class.

The Vectors must always be of length two.

Implements casa::Random.


Member Data Documentation

Definition at line 1310 of file Random.h.

Definition at line 1309 of file Random.h.

Referenced by high().

Definition at line 1308 of file Random.h.

Referenced by low().


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