|
||||||||||
| 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.
| Field Summary | |
|---|---|
static double |
DEFAULT_INVERSE_ABSOLUTE_ACCURACY
Default inverse cumulative probability accuracy |
| Fields inherited from class org.apache.commons.math.distribution.AbstractContinuousDistribution |
|---|
randomData |
| 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. |
|
CauchyDistributionImpl(double median,
double s,
double inverseCumAccuracy)
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). |
double |
density(double x)
Returns the 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 |
getNumericalMean()
Returns the mean. |
double |
getNumericalVariance()
Returns the variance. |
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()
Returns the lower bound of the support for this distribution. |
double |
getSupportUpperBound()
Returns the upper bound of the support for this distribution. |
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)
Deprecated. as of 2.1 (class will become immutable in 3.0) |
void |
setScale(double s)
Deprecated. as of 2.1 (class will become immutable in 3.0) |
| Methods inherited from class org.apache.commons.math.distribution.AbstractContinuousDistribution |
|---|
reseedRandomGenerator, sample, sample |
| 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 |
| Field Detail |
|---|
public static final double DEFAULT_INVERSE_ABSOLUTE_ACCURACY
| Constructor Detail |
|---|
public CauchyDistributionImpl()
public CauchyDistributionImpl(double median,
double s)
median - median for this distributions - scale parameter for this distribution
public CauchyDistributionImpl(double median,
double s,
double inverseCumAccuracy)
median - median for this distributions - scale parameter for this distributioninverseCumAccuracy - the maximum absolute error in inverse cumulative probability estimates
(defaults to DEFAULT_INVERSE_ABSOLUTE_ACCURACY)| Method Detail |
|---|
public double cumulativeProbability(double x)
x).
cumulativeProbability in interface Distributionx - the value at which the CDF is evaluated.
x.public double getMedian()
getMedian in interface CauchyDistributionpublic double getScale()
getScale in interface CauchyDistributionpublic double density(double x)
density in class AbstractContinuousDistributionx - The point at which the density should be computed.
public double inverseCumulativeProbability(double p)
p.
Returns Double.NEGATIVE_INFINITY for p=0 and
Double.POSITIVE_INFINITY for p=1.
inverseCumulativeProbability in interface ContinuousDistributioninverseCumulativeProbability in class AbstractContinuousDistributionp - the desired probability
p
IllegalArgumentException - if p is not a valid
probability.@Deprecated public void setMedian(double median)
setMedian in interface CauchyDistributionmedian - for this distribution@Deprecated public void setScale(double s)
setScale in interface CauchyDistributions - scale parameter for this distribution
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 AbstractContinuousDistributionp - the desired probability for the critical value
pprotected 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 AbstractContinuousDistributionp - the desired probability for the critical value
pprotected 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 AbstractContinuousDistributionp - the desired probability for the critical value
protected double getSolverAbsoluteAccuracy()
getSolverAbsoluteAccuracy in class AbstractContinuousDistributionpublic double getSupportLowerBound()
public double getSupportUpperBound()
public double getNumericalMean()
public double getNumericalVariance()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||