|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.math.distribution.AbstractDistribution
org.apache.commons.math.distribution.AbstractContinuousDistribution
org.apache.commons.math.distribution.CauchyDistributionImpl
public class CauchyDistributionImpl
Default implementation of
CauchyDistribution
.
Constructor Summary | |
---|---|
CauchyDistributionImpl()
Creates cauchy distribution with the medain equal to zero and scale equal to one. |
|
CauchyDistributionImpl(double median,
double s)
Create a cauchy distribution using the given median and scale. |
Method Summary | |
---|---|
double |
cumulativeProbability(double x)
For this distribution, X, this method returns P(X < x ). |
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. |
double |
inverseCumulativeProbability(double p)
For this distribution, X, this method returns the critical point x, such that P(X < x) = p . |
void |
setMedian(double median)
Modify the median. |
void |
setScale(double s)
Modify the scale parameter. |
Methods inherited from class org.apache.commons.math.distribution.AbstractDistribution |
---|
cumulativeProbability |
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.Distribution |
---|
cumulativeProbability |
Constructor Detail |
---|
public CauchyDistributionImpl()
public CauchyDistributionImpl(double median, double s)
median
- median for this distributions
- scale parameter for this distributionMethod Detail |
---|
public double cumulativeProbability(double x)
x
).
cumulativeProbability
in interface Distribution
x
- the value at which the CDF is evaluated.
x
.public double getMedian()
getMedian
in interface CauchyDistribution
public double getScale()
getScale
in interface CauchyDistribution
public double inverseCumulativeProbability(double p)
p
.
Returns Double.NEGATIVE_INFINITY
for p=0 and
Double.POSITIVE_INFINITY
for p=1.
inverseCumulativeProbability
in interface ContinuousDistribution
inverseCumulativeProbability
in class AbstractContinuousDistribution
p
- the desired probability
p
java.lang.IllegalArgumentException
- if p
is not a valid
probability.public void setMedian(double median)
setMedian
in interface CauchyDistribution
median
- for this distributionpublic void setScale(double s)
setScale
in interface CauchyDistribution
s
- scale parameter for this distribution
java.lang.IllegalArgumentException
- if sd
is not positive.protected double getDomainLowerBound(double p)
p
, used to
bracket a CDF root. This method is used by
inverseCumulativeProbability(double)
to find critical values.
getDomainLowerBound
in class AbstractContinuousDistribution
p
- the desired probability for the critical value
p
protected double getDomainUpperBound(double p)
p
, used to
bracket a CDF root. This method is used by
inverseCumulativeProbability(double)
to find critical values.
getDomainUpperBound
in class AbstractContinuousDistribution
p
- the desired probability for the critical value
p
protected double getInitialDomain(double p)
p
, used to
bracket a CDF root. This method is used by
inverseCumulativeProbability(double)
to find critical values.
getInitialDomain
in class AbstractContinuousDistribution
p
- the desired probability for the critical value
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |