de.javagl.sampling.list

Class ListSamplers

java.lang.Object

de.javagl.sampling.list.ListSamplers

public class ListSamplers
extends Object

Factory- and utility methods for ListSampler instances.

Method Summary

Modifier and Type	Method and Description
static ListSampler	createFull() Create a ListSampler where each sample consists of the full list
static <T> List<List<T>>	createList(ListSampler listSampler, List<? extends T> input, int numSamples) Create a list consisting of the samples that are provided by the given ListSampler when it is applied to the given input.
static ListSampler	createWithAbsoluteSize(int absoluteSampleSize, Random random) Create a ListSampler where each sample consists of a random sample of the input list.
static ListSampler	createWithRelativeSize(double relativeSampleSize, Random random) Create a ListSampler where each sample consists of a random sample of the input list.

Methods inherited from class java.lang.Object

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

Method Detail

createList

public static <T> List<List<T>> createList(ListSampler listSampler,
                                           List<? extends T> input,
                                           int numSamples)

Create a list consisting of the samples that are provided by the given ListSampler when it is applied to the given input.

The resulting list will contain at most the given number of samples. If the given ListSampler cannot provide the requested number, the resulting list may contain fewer elements.

Type Parameters:

T - The type of the elements

Parameters:

listSampler - The ListSampler

input - The input

numSamples - The number of samples

Returns:

The list

createFull

public static ListSampler createFull()

Create a ListSampler where each sample consists of the full list

Returns:

The ListSampler

createWithRelativeSize

public static ListSampler createWithRelativeSize(double relativeSampleSize,
                                                 Random random)

Create a ListSampler where each sample consists of a random sample of the input list. The size of each sample will be ceil(input.size() * relativeSampleSize).

Parameters:

relativeSampleSize - The relative sample size

random - The random number generator

Returns:

The ListSampler

Throws:

IllegalArgumentException - If the relative sample size is not in (0.0, 1.0].

createWithAbsoluteSize

public static ListSampler createWithAbsoluteSize(int absoluteSampleSize,
                                                 Random random)

Create a ListSampler where each sample consists of a random sample of the input list. Each sample will have at most the given absolute size. If the resulting sampler is applied to a list that has a size that is smaller than the given sample size, then the full list will be returned.

Parameters:

absoluteSampleSize - The absolute sample size

random - The random number generator

Returns:

The ListSampler

Throws:

IllegalArgumentException - If the sample size is not positive