Class MarsagliaTsangWangDiscreteSampler.Binomial.MarsagliaTsangWangInversionBinomialSampler

java.lang.Object

org.apache.commons.rng.sampling.distribution.MarsagliaTsangWangDiscreteSampler.AbstractMarsagliaTsangWangDiscreteSampler

org.apache.commons.rng.sampling.distribution.MarsagliaTsangWangDiscreteSampler.Binomial.MarsagliaTsangWangInversionBinomialSampler

All Implemented Interfaces:

DiscreteSampler, SharedStateDiscreteSampler, SharedStateSampler<SharedStateDiscreteSampler>

Enclosing class:

MarsagliaTsangWangDiscreteSampler.Binomial

private static final class MarsagliaTsangWangDiscreteSampler.Binomial.MarsagliaTsangWangInversionBinomialSampler
extends MarsagliaTsangWangDiscreteSampler.AbstractMarsagliaTsangWangDiscreteSampler

Return an inversion result for the Binomial distribution. This assumes the following:

Binomial(n, p) = 1 - Binomial(n, 1 - p)

Since:

1.3

Field Summary

Fields

Modifier and Type	Field	Description
private final SharedStateDiscreteSampler	sampler	The Binomial distribution sampler.
private final int	trials	The number of trials.

Fields inherited from class MarsagliaTsangWangDiscreteSampler.AbstractMarsagliaTsangWangDiscreteSampler

rng

Constructor Summary

Constructors

Constructor	Description
MarsagliaTsangWangInversionBinomialSampler(int trials, SharedStateDiscreteSampler sampler)

Method Summary

Modifier and Type	Method	Description
int	sample()	Creates an int sample.
String	toString()
SharedStateDiscreteSampler	withUniformRandomProvider(UniformRandomProvider rng)	Create a new instance of the sampler with the same underlying state using the given uniform random provider as the source of randomness.

Methods inherited from class Object

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

Methods inherited from interface DiscreteSampler

samples, samples

Field Details

trials

private final int trials

The number of trials.

sampler

private final SharedStateDiscreteSampler sampler

The Binomial distribution sampler.

Constructor Details

MarsagliaTsangWangInversionBinomialSampler

MarsagliaTsangWangInversionBinomialSampler(int trials,
 SharedStateDiscreteSampler sampler)

Parameters:

trials - Number of trials.

sampler - Binomial distribution sampler.

Method Details

sample

public int sample()

Description copied from interface: DiscreteSampler

Creates an int sample.

Returns:

a sample.

toString

public String toString()

Description copied from class: MarsagliaTsangWangDiscreteSampler.AbstractMarsagliaTsangWangDiscreteSampler

Overrides:

toString in class MarsagliaTsangWangDiscreteSampler.AbstractMarsagliaTsangWangDiscreteSampler

withUniformRandomProvider

public SharedStateDiscreteSampler withUniformRandomProvider(UniformRandomProvider rng)

Description copied from interface: SharedStateSampler

Create a new instance of the sampler with the same underlying state using the given uniform random provider as the source of randomness.

Parameters:

rng - Generator of uniformly distributed random numbers.

Returns:

the sampler