Package org.apache.commons.rng.sampling

Class CompositeSamplers.SamplerBuilder.WeightedSampler<S>

java.lang.Object

org.apache.commons.rng.sampling.CompositeSamplers.SamplerBuilder.WeightedSampler<S>

Type Parameters:

S - Sampler type

Enclosing class:

CompositeSamplers.SamplerBuilder<S>

private static final class CompositeSamplers.SamplerBuilder.WeightedSampler<S>
extends Object

Contains a weighted sampler.

Field Summary

Fields

Modifier and Type	Field	Description
private final S	sampler	The sampler.
private final double	weight	The weight.

Constructor Summary

Constructors

Constructor	Description
WeightedSampler(double weight, S sampler)

Method Summary

Modifier and Type	Method	Description
(package private) S	getSampler()	Gets the sampler.
(package private) double	getWeight()	Gets the weight.
private static double	requirePositiveFinite(double value, String message)	Checks that the specified value is positive finite and throws a customized IllegalArgumentException if it is not.

Methods inherited from class java.lang.Object

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

Field Details

weight

private final double weight

The weight.

sampler

private final S sampler

The sampler.

Constructor Details

WeightedSampler

WeightedSampler(double weight,
 S sampler)

Parameters:

weight - the weight

sampler - the sampler

Throws:

IllegalArgumentException - if weight is negative, infinite or NaN.

NullPointerException - if sampler is null.

Method Details

getWeight

double getWeight()

Gets the weight.

Returns:

the weight

getSampler

S getSampler()

Gets the sampler.

Returns:

the sampler

requirePositiveFinite

private static double requirePositiveFinite(double value,
 String message)

Checks that the specified value is positive finite and throws a customized IllegalArgumentException if it is not.

Parameters:

value - the value

message - detail message to be used in the event that a IllegalArgumentException is thrown

Returns:

value if positive finite

Throws:

IllegalArgumentException - if weight is negative, infinite or NaN.