Документ взят из кэша поисковой машины. Адрес оригинального документа : http://www.atnf.csiro.au/computing/software/casacore/casacore-1.2.0/doc/html/classcasa_1_1Poisson.html
Дата изменения: Unknown
Дата индексирования: Mon Feb 14 20:55:05 2011
Кодировка:

Поисковые слова: р р р с р с р р р с р с р р р с с р р с р с р р п п р п п п п
casacore: casa::Poisson Class Reference
Public Member Functions | Private Attributes

casa::Poisson Class Reference
[BasicMath_module]

Poisson distribution. More...

#include <Random.h>

Inheritance diagram for casa::Poisson:
casa::Random

List of all members.

Public Member Functions

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

Private Attributes

Double itsMean

Detailed Description

Poisson distribution.

Synopsis

The Poisson class implements a Poisson distribution. The mean parameter, is the only parameter of this distribution. The operator() functions returns a value from this distribution. The remaining members allow you to inspect and change the mean. It is assumed that the supplied mean is non-negative 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 1201 of file Random.h.


Constructor & Destructor Documentation

casa::Poisson::Poisson ( RNG gen,
Double  mean = 0.0 
)

Construct a random number generator for a Poisson 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 argument defines the parameters for this distribution as described in the synopsis.

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

The destructor is trivial.


Member Function Documentation

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

Implements casa::Random.

void casa::Poisson::mean ( Double  x  ) 
Double casa::Poisson::mean (  )  const [inline]

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

Definition at line 1241 of file Random.h.

References itsMean.

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

Returns a value from the Poisson distribution.

The returned value is a non-negative integer and using the asInt function bypasses the conversion to a floating point number.

Implements casa::Random.

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

Implements casa::Random.

virtual void casa::Poisson::setParameters ( const Vector< Double > &  parms  )  [virtual]

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

The Vectors must always be of length one.

Implements casa::Random.


Member Data Documentation

Definition at line 1238 of file Random.h.

Referenced by mean().


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