net.sf.doodleproject.numerics4j.statistics.distribution
Class RayleighDistribution

java.lang.Object
  net.sf.doodleproject.numerics4j.statistics.distribution.ContinuousDistribution
      net.sf.doodleproject.numerics4j.statistics.distribution.RayleighDistribution

All Implemented Interfaces:

Distribution

public class RayleighDistribution
extends ContinuousDistribution

The Rayleigh distribution.

References:

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

Since:

1.2

Version:

$Revision: 1.2 $ $Date: 2007/10/25 04:44:10 $

Constructor Summary

RayleighDistribution()
Default constructor.

RayleighDistribution(double s)
Create a distribution with the scale parameter.

Method Summary

double	cumulativeProbability(double x) The CDF for this distribution.
double	getScale() Access the scale parameter.
double	inverseCumulativeProbability(double p) The inverse CDF for this distribution.
void	setScale(double s) Modify the scale parameter.

Methods inherited from class net.sf.doodleproject.numerics4j.statistics.distribution.ContinuousDistribution

findInverseCumulativeProbability

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RayleighDistribution

public RayleighDistribution()

Default constructor. The scale parameter is set to one.

RayleighDistribution

public RayleighDistribution(double s)

Create a distribution with the scale parameter.

Parameters:

s - the scale parameter.

Method Detail

cumulativeProbability

public double cumulativeProbability(double x)

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

Specified by:

cumulativeProbability in class ContinuousDistribution

Parameters:

x - the value at which the CDF is evaluated.

Returns:

CDF for this distribution.

getScale

public double getScale()

Access the scale parameter.

Returns:

the scale parameter.

inverseCumulativeProbability

public double inverseCumulativeProbability(double p)

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

Specified by:

inverseCumulativeProbability in class ContinuousDistribution

Parameters:

p - the cumulative probability.

Returns:

x

setScale

public void setScale(double s)

Modify the scale parameter.

Parameters:

s - The new scale parameter value.