Package org.apache.commons.rng.sampling

Class CollectionSampler<T>

java.lang.Object

org.apache.commons.rng.sampling.CollectionSampler<T>

Type Parameters:

T - Type of items in the collection.

All Implemented Interfaces:

SharedStateSampler<CollectionSampler<T>>

public class CollectionSampler<T>
extends java.lang.Object
implements SharedStateSampler<CollectionSampler<T>>

Sampling from a Collection.

Sampling uses UniformRandomProvider.nextInt(int).

Since:

1.0

Constructor Summary

Constructors

Constructor	Description
CollectionSampler(org.apache.commons.rng.UniformRandomProvider rng, java.util.Collection<T> collection)	Creates a sampler.

Method Summary

Modifier and Type	Method	Description
T	sample()	Picks one of the items from the collection passed to the constructor.
CollectionSampler<T>	withUniformRandomProvider(org.apache.commons.rng.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, toString, wait, wait, wait

Constructor Detail

CollectionSampler

public CollectionSampler(org.apache.commons.rng.UniformRandomProvider rng,
                         java.util.Collection<T> collection)

Creates a sampler.

Parameters:

rng - Generator of uniformly distributed random numbers.

collection - Collection to be sampled. A (shallow) copy will be stored in the created instance.

Throws:

java.lang.IllegalArgumentException - if collection is empty.

Method Detail

sample

public T sample()

Picks one of the items from the collection passed to the constructor.

Returns:

a random sample.

withUniformRandomProvider

public CollectionSampler<T> withUniformRandomProvider(org.apache.commons.rng.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.

Specified by:

withUniformRandomProvider in interface SharedStateSampler<T>

Parameters:

rng - Generator of uniformly distributed random numbers.

Returns:

the sampler

Since:

1.3