de.javagl.sampling.list

Interface ListSampler

public interface ListSampler

Interface for classes that may provide samples from a given list.

Method Summary

Modifier and Type	Method and Description
<T> Stream<List<T>>	createSamples(List<? extends T> input) Returns a stream of samples from the given list.

Method Detail

createSamples

<T> Stream<List<T>> createSamples(List<? extends T> input)

Returns a stream of samples from the given list. The samples will be returned in form of unmodifiable lists.

Many implementations of this interface are able to provide an infinite stream, although this is not guaranteed.
If the given list is modified after the stream has been created, the behavior of the stream is unspecified.

If the given list is modified after the samples have been obtained from the stream, the behavior of the samples is unspecified.

If the given list has to be modified after the sampling, a copy of the list should be given to this method.

Type Parameters:

T - The type of the elements in the list

Parameters:

input - The input list

Returns:

The stream

Throws:

NullPointerException - If the input is null