Package org.apache.commons.rng.sampling.distribution

Interface DiscreteSampler

All Known Subinterfaces:

SharedStateDiscreteSampler

All Known Implementing Classes:

AliasMethodDiscreteSampler, AliasMethodDiscreteSampler.SmallTableAliasMethodDiscreteSampler, CompositeSamplers.DiscreteSamplerFactory.CompositeDiscreteSampler, CompositeSamplers.SharedStateDiscreteProbabilitySampler, CompositeSamplers.SharedStateDiscreteSamplerFactory.CompositeSharedStateDiscreteSampler, DiscreteUniformSampler, DiscreteUniformSampler.AbstractDiscreteUniformSampler, DiscreteUniformSampler.FixedDiscreteUniformSampler, DiscreteUniformSampler.LargeRangeDiscreteUniformSampler, DiscreteUniformSampler.OffsetDiscreteUniformSampler, DiscreteUniformSampler.PowerOf2RangeDiscreteUniformSampler, DiscreteUniformSampler.SmallRangeDiscreteUniformSampler, FastLoadedDiceRollerDiscreteSampler, FastLoadedDiceRollerDiscreteSampler.FixedValueDiscreteSampler, FastLoadedDiceRollerDiscreteSampler.FLDRSampler, GeometricSampler.GeometricExponentialSampler, GeometricSampler.GeometricP1Sampler, GuideTableDiscreteSampler, InverseTransformDiscreteSampler, KempSmallMeanPoissonSampler, LargeMeanPoissonSampler, MarsagliaTsangWangDiscreteSampler.AbstractMarsagliaTsangWangDiscreteSampler, MarsagliaTsangWangDiscreteSampler.Binomial.MarsagliaTsangWangFixedResultBinomialSampler, MarsagliaTsangWangDiscreteSampler.Binomial.MarsagliaTsangWangInversionBinomialSampler, MarsagliaTsangWangDiscreteSampler.MarsagliaTsangWangBase64Int16DiscreteSampler, MarsagliaTsangWangDiscreteSampler.MarsagliaTsangWangBase64Int32DiscreteSampler, MarsagliaTsangWangDiscreteSampler.MarsagliaTsangWangBase64Int8DiscreteSampler, PoissonSampler, RejectionInversionZipfSampler, RejectionInversionZipfSampler.RejectionInversionZipfSamplerImpl, 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 java.util.stream.IntStream	samples()	Returns an effectively unlimited stream of int sample values.
default java.util.stream.IntStream	samples(long streamSize)	Returns a stream producing the given streamSize number of int sample values.

Method Detail

sample

int sample()

Creates an int sample.

Returns:

a sample.

samples

default java.util.stream.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 java.util.stream.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