|
||||||||||
| 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.AbstractIntegerDistribution
org.apache.commons.math.distribution.ZipfDistributionImpl
public class ZipfDistributionImpl
Implementation for the ZipfDistribution.
| Field Summary |
|---|
| Fields inherited from class org.apache.commons.math.distribution.AbstractIntegerDistribution |
|---|
randomData |
| Constructor Summary | |
|---|---|
ZipfDistributionImpl(int numberOfElements,
double exponent)
Create a new Zipf distribution with the given number of elements and exponent. |
|
| Method Summary | |
|---|---|
double |
cumulativeProbability(int x)
The probability distribution function P(X <= x) for a Zipf distribution. |
protected int |
getDomainLowerBound(double p)
Access the domain value lower bound, based on p, used to
bracket a PDF root. |
protected int |
getDomainUpperBound(double p)
Access the domain value upper bound, based on p, used to
bracket a PDF root. |
double |
getExponent()
Get the exponent characterising the distribution. |
int |
getNumberOfElements()
Get the number of elements (e.g. |
protected double |
getNumericalMean()
Returns the mean. |
protected double |
getNumericalVariance()
Returns the variance. |
int |
getSupportLowerBound()
Returns the lower bound of the support for the distribution. |
int |
getSupportUpperBound()
Returns the upper bound of the support for the distribution. |
double |
probability(int x)
The probability mass function P(X = x) for a Zipf distribution. |
void |
setExponent(double s)
Deprecated. as of 2.1 (class will become immutable in 3.0) |
void |
setNumberOfElements(int n)
Deprecated. as of 2.1 (class will become immutable in 3.0) |
| Methods inherited from class org.apache.commons.math.distribution.AbstractIntegerDistribution |
|---|
cumulativeProbability, cumulativeProbability, cumulativeProbability, inverseCumulativeProbability, isSupportLowerBoundInclusive, isSupportUpperBoundInclusive, probability, reseedRandomGenerator, sample, sample |
| 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.IntegerDistribution |
|---|
cumulativeProbability, inverseCumulativeProbability |
| Methods inherited from interface org.apache.commons.math.distribution.DiscreteDistribution |
|---|
probability |
| Methods inherited from interface org.apache.commons.math.distribution.Distribution |
|---|
cumulativeProbability, cumulativeProbability |
| Constructor Detail |
|---|
public ZipfDistributionImpl(int numberOfElements,
double exponent)
throws IllegalArgumentException
IllegalArgumentException is thrown.
numberOfElements - the number of elementsexponent - the exponent
IllegalArgumentException - if n ≤ 0 or s ≤ 0.0| Method Detail |
|---|
public int getNumberOfElements()
getNumberOfElements in interface ZipfDistribution@Deprecated public void setNumberOfElements(int n)
IllegalArgumentException is thrown.
setNumberOfElements in interface ZipfDistributionn - the number of elements
IllegalArgumentException - if n ≤ 0public double getExponent()
getExponent in interface ZipfDistribution@Deprecated public void setExponent(double s)
IllegalArgumentException is thrown.
setExponent in interface ZipfDistributions - the exponent
IllegalArgumentException - if s ≤ 0.0public double probability(int x)
probability in interface IntegerDistributionx - the value at which the probability density function is evaluated.
public double cumulativeProbability(int x)
cumulativeProbability in interface IntegerDistributioncumulativeProbability in class AbstractIntegerDistributionx - the value at which the PDF is evaluated.
protected int getDomainLowerBound(double p)
p, used to
bracket a PDF root.
getDomainLowerBound in class AbstractIntegerDistributionp - the desired probability for the critical value
pprotected int getDomainUpperBound(double p)
p, used to
bracket a PDF root.
getDomainUpperBound in class AbstractIntegerDistributionp - the desired probability for the critical value
ppublic int getSupportLowerBound()
public int getSupportUpperBound()
protected double getNumericalMean()
Hs1 / Hs where
Hs1 = generalizedHarmonic(N, s - 1)Hs = generalizedHarmonic(N, s)
protected double getNumericalVariance()
(Hs2 / Hs) - (Hs1^2 / Hs^2) where
Hs2 = generalizedHarmonic(N, s - 2)Hs1 = generalizedHarmonic(N, s - 1)Hs = generalizedHarmonic(N, s)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||