org.jscience.mathematics.statistics
Class CauchyDistribution

java.lang.Object
  extended by org.jscience.mathematics.statistics.Distribution
      extended by org.jscience.mathematics.statistics.StudentDistribution
          extended by org.jscience.mathematics.statistics.CauchyDistribution
All Implemented Interfaces:
java.io.Serializable

public class CauchyDistribution
extends StudentDistribution
implements java.io.Serializable

This class models the Cauchy distribution.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.jscience.mathematics.statistics.Distribution
CONTINUOUS, DISCRETE, MIXED
 
Constructor Summary
CauchyDistribution()
          Creates a new CauchyDistribution object.
 
Method Summary
 double getCDF(double x)
          This method computes the cumulative distribuiton function in closed form.
 double getQuantile(double p)
          This method computes the quantile function in closed form.
 void setDegrees(int n)
          This method sets the degrees of freedom which is fixed at 1.
 java.lang.String toString()
          This method returns a string that gives the name of the distribution and the values of the parameters.
 
Methods inherited from class org.jscience.mathematics.statistics.StudentDistribution
getDegrees, getDensity, getMaxDensity, getMean, getMoment, getMoment, getVariance, simulate
 
Methods inherited from class org.jscience.mathematics.statistics.Distribution
getDomain, getFailureRate, getMedian, getMGF, getPGF, getSD, getType, setDomain, setDomain
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CauchyDistribution

public CauchyDistribution()
Creates a new CauchyDistribution object.

Method Detail

getCDF

public double getCDF(double x)
This method computes the cumulative distribuiton function in closed form.

Overrides:
getCDF in class StudentDistribution
Parameters:
x - a number in the domain of the distribution
Returns:
the cumulative probability at x
See Also:
betaCDF

getQuantile

public double getQuantile(double p)
This method computes the quantile function in closed form.

Overrides:
getQuantile in class Distribution
Parameters:
p - a probability in (0, 1)
Returns:
the quantile of order p

setDegrees

public void setDegrees(int n)
This method sets the degrees of freedom which is fixed at 1.

Overrides:
setDegrees in class StudentDistribution
Parameters:
n - the degrees of freedom

toString

public java.lang.String toString()
This method returns a string that gives the name of the distribution and the values of the parameters.

Overrides:
toString in class StudentDistribution
Returns:
a string giving the name of the distribution and the values of the parameters