Class GeometricSampler.GeometricExponentialSampler

java.lang.Object

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

All Implemented Interfaces:

DiscreteSampler, SharedStateDiscreteSampler, SharedStateSampler<SharedStateDiscreteSampler>

Enclosing class:

GeometricSampler

private static final class GeometricSampler.GeometricExponentialSampler
extends Object
implements SharedStateDiscreteSampler

Sample from the geometric distribution by using a related exponential distribution.

Since:

1.3

Field Summary

Fields

Modifier and Type	Field	Description
private final SharedStateContinuousSampler	exponentialSampler	The related exponential sampler for the geometric distribution.
private final UniformRandomProvider	rng	Underlying source of randomness.

Constructor Summary

Constructors

Constructor	Description
GeometricExponentialSampler(UniformRandomProvider rng, double probabilityOfSuccess)
GeometricExponentialSampler(UniformRandomProvider rng, GeometricSampler.GeometricExponentialSampler source)

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

rng

private final UniformRandomProvider rng

Underlying source of randomness. Used only for the toString() method.

exponentialSampler

private final SharedStateContinuousSampler exponentialSampler

The related exponential sampler for the geometric distribution.

Constructor Details

GeometricExponentialSampler

GeometricExponentialSampler(UniformRandomProvider rng,
 double probabilityOfSuccess)

Parameters:

rng - Generator of uniformly distributed random numbers

probabilityOfSuccess - The probability of success (must be in the range [0 < probabilityOfSuccess < 1])

GeometricExponentialSampler

GeometricExponentialSampler(UniformRandomProvider rng,
 GeometricSampler.GeometricExponentialSampler source)

Parameters:

rng - Generator of uniformly distributed random numbers

source - Source to copy.

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