org.openimaj.util

Interface CollectionSampler<T>

Type Parameters:

T - type of items in the collection being sampled

All Known Implementing Classes:

BucketingSampler2d, UniformSampler

public interface CollectionSampler<T>

Interface defining an object capable of sampling a collection.

Author:

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

Method Summary

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

Method Detail

setCollection

void setCollection(Collection<? extends T> collection)

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.

Parameters:

collection - the items to sample from

sample

List<T> sample(int nItems)

Samples nItems items from the collection set by 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.

Parameters:

nItems - the number of items to sample

Returns:

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