org.apache.commons.rng.sampling.distribution

Class DiscreteUniformSampler

java.lang.Object

org.apache.commons.rng.sampling.distribution.SamplerBase

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

All Implemented Interfaces:

DiscreteSampler

public class DiscreteUniformSampler
extends SamplerBase
implements DiscreteSampler

Discrete uniform distribution sampler.

Constructor Summary

Constructors

Constructor and Description
DiscreteUniformSampler(UniformRandomProvider rng, int lower, int upper)

Method Summary

Modifier and Type	Method and Description
int	sample() Creates a sample.
String	toString()

Methods inherited from class org.apache.commons.rng.sampling.distribution.SamplerBase

nextDouble, nextInt, nextInt

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscreteUniformSampler

public DiscreteUniformSampler(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.

Throws:

IllegalArgumentException - if lower > upper.

Method Detail

sample

public int sample()

Creates a sample.

Specified by:

sample in interface DiscreteSampler

Returns:

a sample.

toString

public String toString()

Overrides:

toString in class SamplerBase