Apache
/
commons-math
mirror of https://github.com/apache/commons-math.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Missing javadoc.

This commit is contained in:
Luc Maisonobe 2015-08-31 13:55:31 +02:00
parent 79bbb3054c
commit afe2f3e002
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/main/java/org/apache/commons/math3/distribution/ZipfDistribution.java
View File

@ -260,6 +260,9 @@ public class ZipfDistribution extends AbstractIntegerDistribution {
return true; return true;
} }
/**
* {@inheritDoc}
*/
public int sample() { public int sample() {
if (sampler == null) { if (sampler == null) {
sampler = new ZipfRejectionInversionSampler(numberOfElements, exponent); sampler = new ZipfRejectionInversionSampler(numberOfElements, exponent);
@ -304,6 +307,10 @@ public class ZipfDistribution extends AbstractIntegerDistribution {
/** Constant equal to {@code 2 - hIntegralInverse(hIntegral(2.5) - h(2)}. */ /** Constant equal to {@code 2 - hIntegralInverse(hIntegral(2.5) - h(2)}. */
private final double s; private final double s;
/** Simple constructor.
* @param numberOfElements number of elements
* @param exponent exponent parameter of the distribution
*/
ZipfRejectionInversionSampler(final int numberOfElements, final double exponent) { ZipfRejectionInversionSampler(final int numberOfElements, final double exponent) {
this.exponent = exponent; this.exponent = exponent;
this.numberOfElements = numberOfElements; this.numberOfElements = numberOfElements;
@ -312,6 +319,10 @@ public class ZipfDistribution extends AbstractIntegerDistribution {
this.s = 2d - hIntegralInverse(hIntegral(2.5) - h(2)); this.s = 2d - hIntegralInverse(hIntegral(2.5) - h(2));
} }
/** Generate one integral number in the range [1, numberOfElements].
* @param random random generator to use
* @return generated integral number in the range [1, numberOfElements]
*/
int sample(final RandomGenerator random) { int sample(final RandomGenerator random) {
while(true) { while(true) {