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.

public class CollectionSampler<T>
extends Object

Sampling from a Collection.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
CollectionSampler(UniformRandomProvider rng, Collection<T> collection) Creates a sampler.

Method Summary

Modifier and Type	Method and Description
T	sample() Picks one of the items in the given collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionSampler

public CollectionSampler(UniformRandomProvider rng,
                         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:

IllegalArgumentException - if collection.size() <= 0.

Method Detail

sample

public T sample()

Picks one of the items in the given collection.

Sampling is without replacement; but if the source collection contains identical objects, the sample may include repeats.

There is no guarantee that the concrete type of the returned collection is the same as the source collection.

Returns:

a random sample.