de.javagl.sampling.list

Class ListSampling

java.lang.Object

de.javagl.sampling.list.ListSampling

public class ListSampling
extends Object

Methods to create random samples from lists

Method Summary

Modifier and Type	Method and Description
static <T> List<T>	createSample(List<? extends T> list, int sampleSize, Random random) Creates a random sample from the given list, with the given size.
static <T> Stream<List<T>>	createSamples(List<? extends T> list, int sampleSize, Random random) Creates a stream that provides random samples from the given list, each having the given size.

Methods inherited from class java.lang.Object

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

Method Detail

createSamples

public static <T> Stream<List<T>> createSamples(List<? extends T> list,
                                                int sampleSize,
                                                Random random)

Creates a stream that provides random samples from the given list, each having the given size.

Type Parameters:

T - The type of the elements in the list

Parameters:

list - The input list

sampleSize - The sample size

random - The random number generator

Returns:

The stream

Throws:

IllegalArgumentException - If the sample size is not positive, or the sample size is larger than the list size

createSample

public static <T> List<T> createSample(List<? extends T> list,
                                       int sampleSize,
                                       Random random)

Creates a random sample from the given list, with the given size.

The returned list will contain distinct elements from the given list, in random order.

The returned list will be an unmodifiable view on the given list. This means that changes in the given list will affect the returned list. If the given list is structurally modified after it was passed to this method, the behavior of the returned list is undefined.

Type Parameters:

T - The type of the elements in the list

Parameters:

list - The list

sampleSize - The size of the sample

random - The random number generator

Returns:

The random sample

Throws:

IllegalArgumentException - If the sample size is negative or larger than the list size