| java.lang.Object
 org.apache.commons.math.distribution.AbstractDistribution
org.apache.commons.math.distribution.AbstractContinuousDistribution
org.apache.commons.math.distribution.CauchyDistributionImpl
| Constructor Summary | |
| public | CauchyDistributionImpl()
Creates cauchy distribution with the medain equal to zero and scale
equal to one. | | public | CauchyDistributionImpl(double median, double s)
Create a cauchy distribution using the given median and scale. |
| Method Summary | |
| public double | cumulativeProbability(double x)
For this disbution, X, this method returns P(X < x).
Parameters:
x - the value at which the CDF is evaluated. | | 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. | | public double | getMedian()
Access the median. | | public double | getScale()
Access the scale parameter. | | public double | inverseCumulativeProbability(double p)
For this distribution, X, this method returns the critical point x, such
that P(X < x) = p. | | public void | setMedian(double median)
Modify the median. | | public void | setScale(double s)
Modify the scale parameter. |
| CauchyDistributionImpl | | public CauchyDistributionImpl()(Code) | | Creates cauchy distribution with the medain equal to zero and scale
equal to one.
|
| CauchyDistributionImpl | | public CauchyDistributionImpl(double median, double s)(Code) | | Create a cauchy distribution using the given median and scale.
Parameters:
median - median for this distribution
Parameters:
s - scale parameter for this distribution |
| cumulativeProbability | | public double cumulativeProbability(double x)(Code) | | For this disbution, X, this method returns P(X < x).
Parameters:
x - the value at which the CDF is evaluated. CDF evaluted at x. |
| getDomainLowerBound | | protected double getDomainLowerBound(double p)(Code) | | Access the domain value lower bound, based on p, used to
bracket a CDF root. This method is used by
CauchyDistributionImpl.inverseCumulativeProbability(double) to find critical values.
Parameters:
p - the desired probability for the critical value domain value lower bound, i.e.P(X < lower bound) < p |
| getDomainUpperBound | | protected double getDomainUpperBound(double p)(Code) | | Access the domain value upper bound, based on p, used to
bracket a CDF root. This method is used by
CauchyDistributionImpl.inverseCumulativeProbability(double) to find critical values.
Parameters:
p - the desired probability for the critical value domain value upper bound, i.e.P(X < upper bound) > p |
| getInitialDomain | | protected double getInitialDomain(double p)(Code) | | Access the initial domain value, based on p, used to
bracket a CDF root. This method is used by
CauchyDistributionImpl.inverseCumulativeProbability(double) to find critical values.
Parameters:
p - the desired probability for the critical value initial domain value |
| getMedian | | public double getMedian()(Code) | | Access the median.
median for this distribution |
| getScale | | public double getScale()(Code) | | Access the scale parameter.
scale parameter for this distribution |
| inverseCumulativeProbability | | public double inverseCumulativeProbability(double p)(Code) | | For this distribution, X, this method returns the critical point x, such
that P(X < x) = p.
Returns Double.NEGATIVE_INFINITY for p=0 and
Double.POSITIVE_INFINITY for p=1.
Parameters:
p - the desired probability x, such that P(X < x) = p
throws:
IllegalArgumentException - if p is not a validprobability. |
| setMedian | | public void setMedian(double median)(Code) | | Modify the median.
Parameters:
median - for this distribution |
| setScale | | public void setScale(double s)(Code) | | Modify the scale parameter.
Parameters:
s - scale parameter for this distribution
throws:
IllegalArgumentException - if sd is not positive. |
| Methods inherited from org.apache.commons.math.distribution.AbstractContinuousDistribution | abstract protected double getDomainLowerBound(double p)(Code)(Java Doc)
abstract protected double getDomainUpperBound(double p)(Code)(Java Doc)
abstract protected double getInitialDomain(double p)(Code)(Java Doc)
public double inverseCumulativeProbability(double p) throws MathException(Code)(Java Doc)
|
| Methods inherited from org.apache.commons.math.distribution.AbstractDistribution | public double cumulativeProbability(double x0, double x1) throws MathException(Code)(Java Doc)
|
|
|