API documentation of the 'jhplot.math.num.pdf.Rayleigh' Java class
Rayleigh
jhplot.math.num.pdf

## Class Rayleigh

Rayleigh
jhplot.math.num.pdf

## Class Rayleigh

• All Implemented Interfaces:
Distribution

`public class Rayleighextends ContinuousDistribution`

The Rayleigh distribution.

References:

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

Since:
1.2
• ### Constructor Summary

Constructors
Constructor and Description
`Rayleigh()`
Default constructor.
`Rayleigh(double s)`
Create a distribution with the scale parameter.
• ### Method Summary

All Methods
Modifier and TypeMethod and Description
`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 java.lang.Object

`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`
• ### Constructor Detail

• #### Rayleigh

`public Rayleigh()`
Default constructor. The scale parameter is set to one.
• #### Rayleigh

`public Rayleigh(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.

DMelt 2.0 © DataMelt by jWork.ORG