Class SmallMeanPoissonSampler
- java.lang.Object
-
- org.apache.commons.rng.sampling.distribution.SmallMeanPoissonSampler
-
- All Implemented Interfaces:
DiscreteSampler,SharedStateDiscreteSampler,SharedStateSampler<SharedStateDiscreteSampler>
public class SmallMeanPoissonSampler extends 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 by1000 * mean.
This sampler is suitable for
mean < 40. For large means,LargeMeanPoissonSamplershould be used instead.Sampling uses
UniformRandomProvider.nextDouble()and requires on averagemean + 1deviates per sample.- Since:
- 1.1
-
-
Constructor Summary
Constructors Constructor Description SmallMeanPoissonSampler(UniformRandomProvider rng, double mean)Create an instance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SharedStateDiscreteSamplerof(UniformRandomProvider rng, double mean)Creates a new sampler for the Poisson distribution.intsample()Creates anintsample.StringtoString()SharedStateDiscreteSamplerwithUniformRandomProvider(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
-
Methods inherited from interface org.apache.commons.rng.sampling.distribution.DiscreteSampler
samples, samples
-
-
-
-
Constructor Detail
-
SmallMeanPoissonSampler
public SmallMeanPoissonSampler(UniformRandomProvider rng, double mean)
Create an instance.- Parameters:
rng- Generator of uniformly distributed random numbers.mean- Mean.- Throws:
IllegalArgumentException- ifmean <= 0orMath.exp(-mean) == 0
-
-
Method Detail
-
sample
public int sample()
Creates anintsample.- Specified by:
samplein interfaceDiscreteSampler- Returns:
- a sample.
-
withUniformRandomProvider
public SharedStateDiscreteSampler withUniformRandomProvider(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:
withUniformRandomProviderin interfaceSharedStateSampler<SharedStateDiscreteSampler>- Parameters:
rng- Generator of uniformly distributed random numbers.- Returns:
- the sampler
- Since:
- 1.3
-
of
public static SharedStateDiscreteSampler of(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:
IllegalArgumentException- ifmean <= 0orMath.exp(-mean) == 0.- Since:
- 1.3
-
-