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

Weibull distribution. More...

#include <Random.h>

Inheritance diagram for casa::Weibull:
casa::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 <tt>Weibull</tt> class implements a weibull distribution with
parameters <tt>alpha</tt> and <tt>beta</tt>.  The first parameter to the
class constructor is <tt>alpha</tt>, and the second parameter is
<tt>beta</tt>.  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.

<h3>Example</h3> @anchor Random_example

Thrown Exceptions

To Do

Definition at line 1345 of file Random.h.


Constructor & Destructor Documentation

casa::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 casa::Weibull::~Weibull ( ) [virtual]

The destructor is trivial.


Member Function Documentation

Double casa::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.

Double casa::Weibull::beta ( ) const [inline]

Definition at line 1389 of file Random.h.

References itsBeta.

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

Implements casa::Random.

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

Returns a value from the Weiball distribution.

Implements casa::Random.

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

Implements casa::Random.

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

void casa::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: