rayleigh_distribution Class Reference

#include <rayleigh.h>

Inheritance diagram for rayleigh_distribution:

continuous_distribution

List of all members.

Public Member Functions

 rayleigh_distribution (double scale=1.0)
double cdf (double x) const
double inverse_cdf (double p) const
double scale () const
void scale (double b)

Detailed Description

The Rayleigh distribution.

References:

  1. Eric W. Weisstein. "Rayleigh Distribution." From MathWorld--A Wolfram Web Resource. http://mathworld.wolfram.com/RayleighDistribution.html

Constructor & Destructor Documentation

NUM_NAMESPACE_BEGIN rayleigh_distribution::rayleigh_distribution ( double  s = 1.0  ) 

Create a distribution with the given scale value.

Parameters:
scale the scale parameter.
Create a distribution with the given scale value.
Parameters:
s the scale parameter.

Member Function Documentation

double rayleigh_distribution::cdf ( double  x  )  const [virtual]

The CDF for this distribution. This method returns P(X < x).

Parameters:
x the value at which the CDF is evaluated.
Returns:
CDF for this distribution.

Implements continuous_distribution.

double rayleigh_distribution::inverse_cdf ( double  p  )  const [virtual]

The inverse CDF for this distribution. This method returns x such that, P(X < x) = p.

Parameters:
p the cumulative probability.
Returns:
x

Implements continuous_distribution.

double rayleigh_distribution::scale (  )  const

Access the scale parameter.

Returns:
the scale parameter.

void rayleigh_distribution::scale ( double  s  ) 

Modify the scale parameter.

Parameters:
b the new scale value.

The documentation for this class was generated from the following files:
Generated on Wed Nov 21 22:22:16 2007 for numerics4c++ by  doxygen 1.5.3