Class GeometricSampler.GeometricP1Sampler

java.lang.Object

org.apache.commons.rng.sampling.distribution.GeometricSampler.GeometricP1Sampler

All Implemented Interfaces:

DiscreteSampler, SharedStateDiscreteSampler, SharedStateSampler<SharedStateDiscreteSampler>

Enclosing class:

GeometricSampler

private static final class GeometricSampler.GeometricP1Sampler
extends Object
implements SharedStateDiscreteSampler

Sample from the geometric distribution when the probability of success is 1.

Since:

1.3

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final GeometricSampler.GeometricP1Sampler	INSTANCE	The single instance.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	GeometricP1Sampler()

Method Summary

Modifier and Type	Method	Description
int	sample()	Creates an int sample.
String	toString()
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.

Methods inherited from class Object

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

Methods inherited from interface DiscreteSampler

samples, samples

Field Details

INSTANCE

static final GeometricSampler.GeometricP1Sampler INSTANCE

The single instance.

Constructor Details

GeometricP1Sampler

private GeometricP1Sampler()

Method Details

sample

public int sample()

Description copied from interface: DiscreteSampler

Creates an int sample.

Specified by:

sample in interface DiscreteSampler

Returns:

a sample.

toString

public String toString()

Overrides:

toString in class Object

withUniformRandomProvider

public SharedStateDiscreteSampler withUniformRandomProvider(UniformRandomProvider rng)

Description copied from interface: SharedStateSampler

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