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

Class DiscreteUniformSampler.OffsetDiscreteUniformSampler

java.lang.Object

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

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

All Implemented Interfaces:

DiscreteSampler, SharedStateDiscreteSampler, SharedStateSampler<SharedStateDiscreteSampler>

Enclosing class:

DiscreteUniformSampler

private static final class DiscreteUniformSampler.OffsetDiscreteUniformSampler
extends DiscreteUniformSampler.AbstractDiscreteUniformSampler

Adds an offset to an underlying discrete sampler.

Field Summary

Fields

Modifier and Type	Field	Description
private final int	offset	The offset.
private final SharedStateDiscreteSampler	sampler	The discrete sampler.

Fields inherited from class org.apache.commons.rng.sampling.distribution.DiscreteUniformSampler.AbstractDiscreteUniformSampler

rng

Constructor Summary

Constructors

Constructor	Description
OffsetDiscreteUniformSampler(int offset, SharedStateDiscreteSampler sampler)

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 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

Field Details

offset

private final int offset

The offset.

sampler

private final SharedStateDiscreteSampler sampler

The discrete sampler.

Constructor Details

OffsetDiscreteUniformSampler

OffsetDiscreteUniformSampler(int offset,
 SharedStateDiscreteSampler sampler)

Parameters:

offset - The offset for the sample.

sampler - The discrete sampler.

Method Details

sample

public int sample()

Description copied from interface: DiscreteSampler

Creates an int sample.

Returns:

a sample.

toString

public String toString()

Overrides:

toString in class DiscreteUniformSampler.AbstractDiscreteUniformSampler

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