Interface ZipfDistribution
- 
- All Superinterfaces:
 DiscreteDistribution,Distribution,IntegerDistribution
- All Known Implementing Classes:
 ZipfDistributionImpl
public interface ZipfDistribution extends IntegerDistribution
The Zipf (or zeta) Distribution.References:
 
- 
- 
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description doublegetExponent()Get the exponent characterising the distribution.intgetNumberOfElements()Get the number of elements (e.g.voidsetExponent(double s)Deprecated.as of v2.1voidsetNumberOfElements(int n)Deprecated.as of v2.1- 
Methods 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 Detail
- 
getNumberOfElements
int getNumberOfElements()
Get the number of elements (e.g. corpus size) for the distribution.- Returns:
 - the number of elements
 
 
- 
setNumberOfElements
@Deprecated void setNumberOfElements(int n)
Deprecated.as of v2.1Set the number of elements (e.g. corpus size) for the distribution. The parameter value must be positive; otherwise anIllegalArgumentExceptionis thrown.- Parameters:
 n- the number of elements- Throws:
 java.lang.IllegalArgumentException- if n ≤ 0
 
- 
getExponent
double getExponent()
Get the exponent characterising the distribution.- Returns:
 - the exponent
 
 
- 
setExponent
@Deprecated void setExponent(double s)
Deprecated.as of v2.1Set the exponent characterising the distribution. The parameter value must be positive; otherwise anIllegalArgumentExceptionis thrown.- Parameters:
 s- the exponent- Throws:
 java.lang.IllegalArgumentException- if s ≤ 0.0
 
 - 
 
 -