org.openimaj.util

Class UniformSampler<T>

java.lang.Object

org.openimaj.util.UniformSampler<T>

Type Parameters:

T - type of items in the collection being sampled

All Implemented Interfaces:

CollectionSampler<T>

public class UniformSampler<T>
extends Object
implements CollectionSampler<T>

Implementation of a CollectionSampler that performs uniform sampling. Each sampled set is sampled without replacement (i.e. an item will only appear once), however there is no guarantee that subsequent calls to sample(int) will return unique sets of samples.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
UniformSampler()

Method Summary

Modifier and Type	Method and Description
List<T>	sample(int nItems) Samples nItems items from the collection set by CollectionSampler.setCollection(Collection), returning a new collection with the given samples.
void	setCollection(Collection<? extends T> collection) Set the items to sample from.

Methods inherited from class java.lang.Object

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

Constructor Detail

UniformSampler

public UniformSampler()

Method Detail

setCollection

public void setCollection(Collection<? extends T> collection)

Description copied from interface: CollectionSampler

Set the items to sample from. This should only be called once for any given set of items. Implementors can assume that calling this resets any state of the sampler.

Specified by:

setCollection in interface CollectionSampler<T>

Parameters:

collection - the items to sample from

sample

public List<T> sample(int nItems)

Description copied from interface: CollectionSampler

Samples nItems items from the collection set by CollectionSampler.setCollection(Collection), returning a new collection with the given samples. Implementations can decide what to do if nItems is bigger than the number of items in the collection.

Specified by:

sample in interface CollectionSampler<T>

Parameters:

nItems - the number of items to sample

Returns:

the sample; can be null if a sample cannot be made for any reason.