org.apache.flink.api.java.sampling

Class BernoulliSampler<T>

java.lang.Object

org.apache.flink.api.java.sampling.RandomSampler<T>

org.apache.flink.api.java.sampling.BernoulliSampler<T>

Type Parameters:

T - The type of sample.

@Internal
public class BernoulliSampler<T>
extends RandomSampler<T>

A sampler implementation built upon a Bernoulli trail. This sampler is used to sample with fraction and without replacement. Whether an element is sampled or not is determined by a Bernoulli experiment.

See Also:

Gap Sampling

Field Summary

Fields inherited from class org.apache.flink.api.java.sampling.RandomSampler

emptyIterable, EPSILON

Constructor Summary

Constructors

Constructor and Description
BernoulliSampler(double fraction) Create a Bernoulli sampler with sample fraction and default random number generator.
BernoulliSampler(double fraction, long seed) Create a Bernoulli sampler with sample fraction and random number generator seed.
BernoulliSampler(double fraction, Random random) Create a Bernoulli sampler with sample fraction and random number generator.

Method Summary

Modifier and Type	Method and Description
Iterator<T>	sample(Iterator<T> input) Sample the input elements, for each input element, take a Bernoulli trail for sampling.

Methods inherited from class java.lang.Object

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

Constructor Detail

BernoulliSampler

public BernoulliSampler(double fraction)

Create a Bernoulli sampler with sample fraction and default random number generator.

Parameters:

fraction - Sample fraction, aka the Bernoulli sampler possibility.

BernoulliSampler

public BernoulliSampler(double fraction,
                        long seed)

Create a Bernoulli sampler with sample fraction and random number generator seed.

Parameters:

fraction - Sample fraction, aka the Bernoulli sampler possibility.

seed - Random number generator seed.

BernoulliSampler

public BernoulliSampler(double fraction,
                        Random random)

Create a Bernoulli sampler with sample fraction and random number generator.

Parameters:

fraction - Sample fraction, aka the Bernoulli sampler possibility.

random - The random number generator.

Method Detail

sample

public Iterator<T> sample(Iterator<T> input)

Sample the input elements, for each input element, take a Bernoulli trail for sampling.

Specified by:

sample in class RandomSampler<T>

Parameters:

input - Elements to be sampled.

Returns:

The sampled result which is lazy computed upon input elements.