Interface ZipfDistribution
- All Superinterfaces:
DiscreteDistribution
,Distribution
,IntegerDistribution
- All Known Implementing Classes:
ZipfDistributionImpl
The Zipf (or zeta) Distribution.
References:
- Version:
- $Revision: 920852 $ $Date: 2010-03-09 13:53:44 +0100 (mar. 09 mars 2010) $
-
Method Summary
Modifier and TypeMethodDescriptiondouble
Get the exponent characterising the distribution.int
Get the number of elements (e.g.void
setExponent
(double s) Deprecated.as of v2.1void
setNumberOfElements
(int n) Deprecated.as of v2.1Methods inherited from interface org.apache.commons.math.distribution.DiscreteDistribution
probability
Methods inherited from interface org.apache.commons.math.distribution.Distribution
cumulativeProbability, cumulativeProbability
Methods inherited from interface org.apache.commons.math.distribution.IntegerDistribution
cumulativeProbability, cumulativeProbability, inverseCumulativeProbability, probability
-
Method Details
-
getNumberOfElements
int getNumberOfElements()Get the number of elements (e.g. corpus size) for the distribution.- Returns:
- the number of elements
-
setNumberOfElements
Deprecated.as of v2.1Set the number of elements (e.g. corpus size) for the distribution. The parameter value must be positive; otherwise anIllegalArgumentException
is thrown.- Parameters:
n
- the number of elements- Throws:
IllegalArgumentException
- if n ≤ 0
-
getExponent
double getExponent()Get the exponent characterising the distribution.- Returns:
- the exponent
-
setExponent
Deprecated.as of v2.1Set the exponent characterising the distribution. The parameter value must be positive; otherwise anIllegalArgumentException
is thrown.- Parameters:
s
- the exponent- Throws:
IllegalArgumentException
- if s ≤ 0.0
-