casacore::Weibull Class Reference

Weibull distribution. More...

#include <Random.h>

Inheritance diagram for casacore::Weibull:
casacore::Random

List of all members.

Public Member Functions

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

Private Member Functions

void setState ()

Private Attributes

Double itsAlpha
Double itsBeta
Double itsInvAlpha

Detailed Description

Weibull distribution.

Synopsis

The Weibull class implements a weibull distribution with parameters alpha and beta. The first parameter to the class constructor is alpha, and the second parameter is beta. It is assumed that the alpha parameter is not zero 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 1345 of file Random.h.


Constructor & Destructor Documentation

casacore::Weibull::Weibull ( RNG gen,
Double  alpha = 1.0,
Double  beta = 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 casacore::Weibull::~Weibull (  )  [virtual]

The destructor is trivial.


Member Function Documentation

void casacore::Weibull::alpha ( Double  x  ) 
Double casacore::Weibull::alpha (  )  const [inline]

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

Definition at line 1385 of file Random.h.

References itsAlpha.

void casacore::Weibull::beta ( Double  x  ) 
Double casacore::Weibull::beta (  )  const [inline]

Definition at line 1389 of file Random.h.

References itsBeta.

virtual Bool casacore::Weibull::checkParameters ( const Vector< Double > &  parms  )  const [virtual]

Implements casacore::Random.

virtual Double casacore::Weibull::operator() (  )  [virtual]

Returns a value from the Weiball distribution.

Implements casacore::Random.

virtual Vector<Double> casacore::Weibull::parameters (  )  const [virtual]

Implements casacore::Random.

virtual void casacore::Weibull::setParameters ( const Vector< Double > &  parms  )  [virtual]

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

The Vectors must always be of length two.

Implements casacore::Random.

void casacore::Weibull::setState (  )  [private]

Member Data Documentation

Definition at line 1380 of file Random.h.

Referenced by alpha().

Definition at line 1381 of file Random.h.

Referenced by beta().

Definition at line 1382 of file Random.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1