Class DiscreteUniformSampler.LargeRangeDiscreteUniformSampler

java.lang.Object

org.apache.commons.rng.sampling.distribution.DiscreteUniformSampler.AbstractDiscreteUniformSampler

org.apache.commons.rng.sampling.distribution.DiscreteUniformSampler.LargeRangeDiscreteUniformSampler

All Implemented Interfaces:

DiscreteSampler, SharedStateDiscreteSampler, SharedStateSampler<SharedStateDiscreteSampler>

Enclosing class:

DiscreteUniformSampler

private static final class DiscreteUniformSampler.LargeRangeDiscreteUniformSampler
extends DiscreteUniformSampler.AbstractDiscreteUniformSampler

Discrete uniform distribution sampler when the range between lower and upper is too large to fit in a positive integer.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
private final int	lower	Lower bound.
private final int	upper	Upper bound.

Fields inherited from class DiscreteUniformSampler.AbstractDiscreteUniformSampler

rng

Constructor Summary

Constructors

Constructor	Description
LargeRangeDiscreteUniformSampler(UniformRandomProvider rng, int lower, int upper)

Method Summary

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

toString

Methods inherited from class Object

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

Methods inherited from interface DiscreteSampler

samples, samples

Field Details

lower

private final int lower

Lower bound.

upper

private final int upper

Upper bound.

Constructor Details

LargeRangeDiscreteUniformSampler

LargeRangeDiscreteUniformSampler(UniformRandomProvider rng,
 int lower,
 int upper)

Parameters:

rng - Generator of uniformly distributed random numbers.

lower - Lower bound (inclusive) of the distribution.

upper - Upper bound (inclusive) of the distribution.

Method Details

sample

public int sample()

Description copied from interface: DiscreteSampler

Creates an int sample.

Returns:

a sample.

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.

Parameters:

rng - Generator of uniformly distributed random numbers.

Returns:

the sampler