Interface DiscreteSampler

All Known Subinterfaces:

SharedStateDiscreteSampler

All Known Implementing Classes:

AliasMethodDiscreteSampler, DiscreteUniformSampler, FastLoadedDiceRollerDiscreteSampler, GuideTableDiscreteSampler, InverseTransformDiscreteSampler, KempSmallMeanPoissonSampler, LargeMeanPoissonSampler, PoissonSampler, RejectionInversionZipfSampler, SmallMeanPoissonSampler

public interface DiscreteSampler

Sampler that generates values of type int.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
int	sample()	Creates an int sample.
default IntStream	samples()	Returns an effectively unlimited stream of int sample values.
default IntStream	samples(long streamSize)	Returns a stream producing the given streamSize number of int sample values.

Method Details

sample

int sample()

Creates an int sample.

Returns:

a sample.

samples

default IntStream samples()

Returns an effectively unlimited stream of int sample values.

The default implementation produces a sequential stream that repeatedly calls sample().

Returns:

a stream of int values.

Since:

1.5

samples

default IntStream samples(long streamSize)

Returns a stream producing the given streamSize number of int sample values.

The default implementation produces a sequential stream that repeatedly calls sample(); the stream is limited to the given streamSize.

Parameters:

streamSize - Number of values to generate.

Returns:

a stream of int values.

Since:

1.5