#include <Random.h>
Public Member Functions | |
| Weibull (RNG *gen, Double alpha=1.0, Double beta=1.0) | |
| Construct a random number generator for a uniform distribution. More... | |
| virtual | ~Weibull () |
| The destructor is trivial. More... | |
| virtual Double | operator() () |
| Returns a value from the Weiball distribution. More... | |
| Double | alpha () const |
| Functions that allow you to query and change the parameters of the Weiball distribution. More... | |
| 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. 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 Member Functions | |
| void | setState () |
Private Attributes | |
| Double | itsAlpha |
| Double | itsBeta |
| Double | itsInvAlpha |
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
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
- AipsError: if bad values for the arguments are given, as specified above.
To Do
- Nothing I hope!
Constructor & Destructor Documentation
◆ Weibull()
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.
◆ ~Weibull()
|
virtual |
The destructor is trivial.
Member Function Documentation
◆ alpha() [1/2]
|
inline |
◆ alpha() [2/2]
| void casacore::Weibull::alpha | ( | Double | x | ) |
◆ beta() [1/2]
|
inline |
◆ beta() [2/2]
| void casacore::Weibull::beta | ( | Double | x | ) |
◆ checkParameters()
Implements casacore::Random.
◆ operator()()
|
virtual |
◆ parameters()
Implements casacore::Random.
◆ setParameters()
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.
◆ setState()
|
private |
Member Data Documentation
◆ itsAlpha
|
private |
◆ itsBeta
|
private |
◆ itsInvAlpha
The documentation for this class was generated from the following file:
- casa/BasicMath/Random.h
