org.apache.commons.math.distribution
Class CauchyDistributionImpl

java.lang.Object
  org.apache.commons.math.distribution.AbstractDistribution
      org.apache.commons.math.distribution.AbstractContinuousDistribution
          org.apache.commons.math.distribution.CauchyDistributionImpl

All Implemented Interfaces:

java.io.Serializable, CauchyDistribution, ContinuousDistribution, Distribution

public class CauchyDistributionImpl
extends AbstractContinuousDistribution
implements CauchyDistribution, java.io.Serializable

Default implementation of CauchyDistribution.

Since:

1.1

Version:

$Id: CauchyDistributionImpl.java 1131229 2011-06-03 20:49:25Z luc $

See Also:

Serialized Form

Field Summary

static double

DEFAULT_INVERSE_ABSOLUTE_ACCURACY Default inverse cumulative probability accuracy.

Fields inherited from class org.apache.commons.math.distribution.AbstractContinuousDistribution

randomData, SOLVER_DEFAULT_ABSOLUTE_ACCURACY

Constructor Summary

CauchyDistributionImpl()
Creates cauchy distribution with the medain equal to zero and scale equal to one.

CauchyDistributionImpl(double median, double scale)
Create a cauchy distribution using the given median and scale.

CauchyDistributionImpl(double median, double scale, double inverseCumAccuracy)
Create a cauchy distribution using the given median and scale.

Method Summary

protected double	calculateNumericalMean() Use this method to actually calculate the mean for the specific distribution.
protected double	calculateNumericalVariance() Use this method to actually calculate the variance for the specific distribution.
double	cumulativeProbability(double x) For this distribution, X, this method returns P(X < x).
double	density(double x) Probability density for a particular point.
protected double	getDomainLowerBound(double p) Access the domain value lower bound, based on p, used to bracket a CDF root.
protected double	getDomainUpperBound(double p) Access the domain value upper bound, based on p, used to bracket a CDF root.
protected double	getInitialDomain(double p) Access the initial domain value, based on p, used to bracket a CDF root.
double	getMedian() Access the median.
double	getScale() Access the scale parameter.
protected double	getSolverAbsoluteAccuracy() Return the absolute accuracy setting of the solver used to estimate inverse cumulative probabilities.
double	getSupportLowerBound() Access the lower bound of the support.
double	getSupportUpperBound() Access the upper bound of the support.
double	inverseCumulativeProbability(double p) For this distribution, X, this method returns the critical point x, such that P(X < x) = p.
boolean	isSupportLowerBoundInclusive() Use this method to get information about whether the lower bound of the support is inclusive or not.
boolean	isSupportUpperBoundInclusive() Use this method to get information about whether the upper bound of the support is inclusive or not.

Methods inherited from class org.apache.commons.math.distribution.AbstractContinuousDistribution

reseedRandomGenerator, sample, sample

Methods inherited from class org.apache.commons.math.distribution.AbstractDistribution

cumulativeProbability, getNumericalMean, getNumericalVariance, isSupportConnected

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.math.distribution.ContinuousDistribution

reseedRandomGenerator, sample, sample

Methods inherited from interface org.apache.commons.math.distribution.Distribution

cumulativeProbability, getNumericalMean, getNumericalVariance, isSupportConnected

Field Detail

DEFAULT_INVERSE_ABSOLUTE_ACCURACY

public static final double DEFAULT_INVERSE_ABSOLUTE_ACCURACY

Default inverse cumulative probability accuracy.

Since:

2.1

See Also:

Constant Field Values

Constructor Detail

CauchyDistributionImpl

public CauchyDistributionImpl()

Creates cauchy distribution with the medain equal to zero and scale equal to one.

CauchyDistributionImpl

public CauchyDistributionImpl(double median,
                              double scale)

Create a cauchy distribution using the given median and scale.

Parameters:

median - Median for this distribution.

scale - Scale parameter for this distribution.

CauchyDistributionImpl

public CauchyDistributionImpl(double median,
                              double scale,
                              double inverseCumAccuracy)

Create a cauchy distribution using the given median and scale.

Parameters:

median - Median for this distribution.

scale - Scale parameter for this distribution.

inverseCumAccuracy - Maximum absolute error in inverse cumulative probability estimates (defaults to DEFAULT_INVERSE_ABSOLUTE_ACCURACY).

Throws:

NotStrictlyPositiveException - if s <= 0.

Since:

2.1

Method Detail

cumulativeProbability

public double cumulativeProbability(double x)

For this distribution, X, this method returns P(X < x).

Specified by:

cumulativeProbability in interface Distribution

Parameters:

x - Value at which the CDF is evaluated.

Returns:

CDF evaluated at x.

getMedian

public double getMedian()

Access the median.

Specified by:

getMedian in interface CauchyDistribution

Returns:

the median for this distribution.

getScale

public double getScale()

Access the scale parameter.

Specified by:

getScale in interface CauchyDistribution

Returns:

the scale parameter for this distribution.

density

public double density(double x)

Probability density for a particular point.

Specified by:

density in interface ContinuousDistribution

Specified by:

density in class AbstractContinuousDistribution

Parameters:

x - Point at which the density should be computed.

Returns:

the pdf at point x.

inverseCumulativeProbability

public double inverseCumulativeProbability(double p)

For this distribution, X, this method returns the critical point x, such that P(X < x) = p. It will return Double.NEGATIVE_INFINITY when p = 0 and Double.POSITIVE_INFINITY when p = 1.

Specified by:

inverseCumulativeProbability in interface ContinuousDistribution

Overrides:

inverseCumulativeProbability in class AbstractContinuousDistribution

Parameters:

p - Desired probability.

Returns:

x, such that P(X < x) = p.

Throws:

OutOfRangeException - if p is not a valid probability.

getDomainLowerBound

protected double getDomainLowerBound(double p)

Access the domain value lower bound, based on p, used to bracket a CDF root. This method is used by inverseCumulativeProbability(double) to find critical values.

Specified by:

getDomainLowerBound in class AbstractContinuousDistribution

Parameters:

p - Desired probability for the critical value.

Returns:

domain value lower bound, i.e. P(X < 'lower bound') < p.

getDomainUpperBound

protected double getDomainUpperBound(double p)

Access the domain value upper bound, based on p, used to bracket a CDF root. This method is used by inverseCumulativeProbability(double) to find critical values.

Specified by:

getDomainUpperBound in class AbstractContinuousDistribution

Parameters:

p - Desired probability for the critical value.

Returns:

domain value lower bound, i.e. P(X < 'upper bound') > p.

getInitialDomain

protected double getInitialDomain(double p)

Access the initial domain value, based on p, used to bracket a CDF root. This method is used by inverseCumulativeProbability(double) to find critical values.

Specified by:

getInitialDomain in class AbstractContinuousDistribution

Parameters:

p - Desired probability for the critical value.

Returns:

the initial domain value.

getSolverAbsoluteAccuracy

protected double getSolverAbsoluteAccuracy()

Return the absolute accuracy setting of the solver used to estimate inverse cumulative probabilities.

Overrides:

getSolverAbsoluteAccuracy in class AbstractContinuousDistribution

Returns:

the solver absolute accuracy

Since:

2.1

getSupportLowerBound

public double getSupportLowerBound()

Access the lower bound of the support. The lower bound of the support is always negative infinity no matter the parameters.

Specified by:

getSupportLowerBound in class AbstractContinuousDistribution

Returns:

lower bound of the support (always Double.NEGATIVE_INFINITY)

getSupportUpperBound

public double getSupportUpperBound()

Access the upper bound of the support. The upper bound of the support is always positive infinity no matter the parameters.

Specified by:

getSupportUpperBound in class AbstractContinuousDistribution

Returns:

upper bound of the support (always Double.POSITIVE_INFINITY)

calculateNumericalMean

protected double calculateNumericalMean()

Use this method to actually calculate the mean for the specific distribution. Use AbstractDistribution.getNumericalMean() (which implements caching) to actually get the mean. The mean is always undefined no matter the parameters.

Specified by:

calculateNumericalMean in class AbstractDistribution

Returns:

mean (always Double.NaN)

calculateNumericalVariance

protected double calculateNumericalVariance()

Use this method to actually calculate the variance for the specific distribution. Use AbstractDistribution.getNumericalVariance() (which implements caching) to actually get the variance. The variance is always undefined no matter the parameters.

Specified by:

calculateNumericalVariance in class AbstractDistribution

Returns:

variance (always Double.NaN)

isSupportLowerBoundInclusive

public boolean isSupportLowerBoundInclusive()

Use this method to get information about whether the lower bound of the support is inclusive or not.

Specified by:

isSupportLowerBoundInclusive in interface Distribution

Specified by:

isSupportLowerBoundInclusive in class AbstractDistribution

Returns:

whether the lower bound of the support is inclusive or not

isSupportUpperBoundInclusive

public boolean isSupportUpperBoundInclusive()

Use this method to get information about whether the upper bound of the support is inclusive or not.

Specified by:

isSupportUpperBoundInclusive in interface Distribution

Specified by:

isSupportUpperBoundInclusive in class AbstractDistribution

Returns:

whether the upper bound of the support is inclusive or not