Package org.apache.commons.rng.sampling.distribution

Class SmallMeanPoissonSampler

java.lang.Object

org.apache.commons.rng.sampling.distribution.SmallMeanPoissonSampler

All Implemented Interfaces:

DiscreteSampler, SharedStateDiscreteSampler, SharedStateSampler<SharedStateDiscreteSampler>

public class SmallMeanPoissonSampler
extends java.lang.Object
implements SharedStateDiscreteSampler

Sampler for the Poisson distribution.

• For small means, a Poisson process is simulated using uniform deviates, as described in

  Knuth (1969). Seminumerical Algorithms. The Art of Computer Programming, Volume 2. Chapter 3.4.1.F.3 Important integer-valued distributions: The Poisson distribution. Addison Wesley.

  The Poisson process (and hence, the returned value) is bounded by 1000 * mean.

This sampler is suitable for mean < 40. For large means, LargeMeanPoissonSampler should be used instead.

Sampling uses UniformRandomProvider.nextDouble() and requires on average mean + 1 deviates per sample.

Since:

1.1

Constructor Summary

Constructors

Constructor	Description
SmallMeanPoissonSampler(org.apache.commons.rng.UniformRandomProvider rng, double mean)

Method Summary

Modifier and Type	Method	Description
static SharedStateDiscreteSampler	of(org.apache.commons.rng.UniformRandomProvider rng, double mean)	Creates a new sampler for the Poisson distribution.
int	sample()	Creates a sample.
java.lang.String	toString()
SharedStateDiscreteSampler	withUniformRandomProvider(org.apache.commons.rng.UniformRandomProvider rng)	Create a new instance of the sampler with the same underlying state using the given uniform random provider as the source of randomness.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SmallMeanPoissonSampler

public SmallMeanPoissonSampler(org.apache.commons.rng.UniformRandomProvider rng,
                               double mean)

Parameters:

rng - Generator of uniformly distributed random numbers.

mean - Mean.

Throws:

java.lang.IllegalArgumentException - if mean <= 0 or Math.exp(-mean) == 0

Method Detail

sample

public int sample()

Creates a sample.

Specified by:

sample in interface DiscreteSampler

Returns:

a sample.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

withUniformRandomProvider

public SharedStateDiscreteSampler withUniformRandomProvider(org.apache.commons.rng.UniformRandomProvider rng)

Create a new instance of the sampler with the same underlying state using the given uniform random provider as the source of randomness.

Specified by:

withUniformRandomProvider in interface SharedStateSampler<SharedStateDiscreteSampler>

Parameters:

rng - Generator of uniformly distributed random numbers.

Returns:

the sampler

Since:

1.3

of

public static SharedStateDiscreteSampler of(org.apache.commons.rng.UniformRandomProvider rng,
                                            double mean)

Creates a new sampler for the Poisson distribution.

Parameters:

rng - Generator of uniformly distributed random numbers.

mean - Mean of the distribution.

Returns:

the sampler

Throws:

java.lang.IllegalArgumentException - if mean <= 0 or Math.exp(-mean) == 0.

Since:

1.3