Class CompositeSamplers.SharedStateDiscreteSamplerFactory.CompositeSharedStateDiscreteSampler

java.lang.Object

org.apache.commons.rng.sampling.CompositeSamplers.CompositeSampler<SharedStateDiscreteSampler>

org.apache.commons.rng.sampling.CompositeSamplers.SharedStateDiscreteSamplerFactory.CompositeSharedStateDiscreteSampler

All Implemented Interfaces:

DiscreteSampler, SharedStateDiscreteSampler, SharedStateSampler<SharedStateDiscreteSampler>

Enclosing class:

CompositeSamplers.SharedStateDiscreteSamplerFactory

private static final class CompositeSamplers.SharedStateDiscreteSamplerFactory.CompositeSharedStateDiscreteSampler
extends CompositeSamplers.CompositeSampler<SharedStateDiscreteSampler>
implements SharedStateDiscreteSampler

A composite discrete sampler with shared state support.

Since:

1.4

Field Summary

Fields inherited from class CompositeSamplers.CompositeSampler

discreteSampler, samplers

Constructor Summary

Constructors

Constructor	Description
CompositeSharedStateDiscreteSampler(SharedStateDiscreteSampler discreteSampler, List<SharedStateDiscreteSampler> samplers)

Method Summary

Modifier and Type	Method	Description
int	sample()	Creates an int sample.
CompositeSamplers.SharedStateDiscreteSamplerFactory.CompositeSharedStateDiscreteSampler	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 CompositeSamplers.CompositeSampler

nextSampler

Methods inherited from class Object

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

Methods inherited from interface DiscreteSampler

samples, samples

Constructor Details

CompositeSharedStateDiscreteSampler

CompositeSharedStateDiscreteSampler(SharedStateDiscreteSampler discreteSampler,
 List<SharedStateDiscreteSampler> samplers)

Parameters:

discreteSampler - Discrete sampler to choose the individual sampler to sample.

samplers - Collection of samplers to be sampled from.

Method Details

sample

public int sample()

Description copied from interface: DiscreteSampler

Creates an int sample.

Specified by:

sample in interface DiscreteSampler

Returns:

a sample.

withUniformRandomProvider

public CompositeSamplers.SharedStateDiscreteSamplerFactory.CompositeSharedStateDiscreteSampler 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.

Specified by:

withUniformRandomProvider in interface SharedStateSampler<SharedStateDiscreteSampler>

Parameters:

rng - Generator of uniformly distributed random numbers.

Returns:

the sampler