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

Since:

1.0

Constructor Summary

Constructors

Constructor	Description
DiscreteUniformSampler(org.apache.commons.rng.UniformRandomProvider rng, int lower, int upper)

Method Summary

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

Methods inherited from class java.lang.Object

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

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

nextDouble, nextInt, nextInt, nextLong

Constructor Detail

DiscreteUniformSampler

public DiscreteUniformSampler(org.apache.commons.rng.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:

java.lang.IllegalArgumentException - if lower > upper.

Method Detail

sample

public int sample()

Creates a sample.

Specified by:

sample in interface DiscreteSampler

Returns:

a sample.

toString

public java.lang.String toString()

Overrides:

toString in class SamplerBase