gslmm::rayleigh_tail Class Reference
[Distributions]

#include <gslmm/random/rayleigh_tail.hh>

Inheritance diagram for gslmm::rayleigh_tail:

Inheritance graph
[legend]
Collaboration diagram for gslmm::rayleigh_tail:

Collaboration graph
[legend]
List of all members.

Detailed Description

Rayleigh Tail distribution interface class.

The Rayleigh Tail PDF is

\[ p(x) dx = {x \over \sigma^2} \exp ((a^2 - x^2) /(2 \sigma^2)) dx \]

for $ x > a$.

Examples:

random/distribution-test.cc.


Public Member Functions

 rayleigh_tail (double a, double sigma, generator &r)
virtual ~rayleigh_tail ()
virtual return_type sample ()
virtual double pdf (const return_type &x)

Protected Types

typedef distribution< double > base_type

Protected Attributes

double _a
double _sigma


Member Typedef Documentation

typedef distribution<double> gslmm::rayleigh_tail::base_type [protected]
 

The base type.


Constructor & Destructor Documentation

gslmm::rayleigh_tail::rayleigh_tail double  a,
double  sigma,
generator r
[inline]
 

Constructor.

Parameters:
a The lower limit
sigma the scale parameter
r The random number generator

virtual gslmm::rayleigh_tail::~rayleigh_tail  )  [inline, virtual]
 

Destructor.


Member Function Documentation

virtual double gslmm::rayleigh_tail::pdf const return_type x  )  [inline, virtual]
 

See also:
gslmm::distribution<Return,Arg>::pdf

virtual return_type gslmm::rayleigh_tail::sample  )  [inline, virtual]
 

Sample the distribution.

Returns:
The sample.

Implements gslmm::distribution< double >.


Member Data Documentation

double gslmm::rayleigh_tail::_a [protected]
 

Parameter a of the distribution.

double gslmm::rayleigh_tail::_sigma [protected]
 

Width ($\sigma$) of the distribution.


The documentation for this class was generated from the following file:
Top of page Last update Tue May 9 10:11:33 2006
Christian Holm
Created by DoxyGen 1.4.6