Class BoxMullerGaussianSampler

java.lang.Object

org.apache.commons.rng.sampling.distribution.SamplerBase

org.apache.commons.rng.sampling.distribution.BoxMullerGaussianSampler

All Implemented Interfaces:

ContinuousSampler

@Deprecated
public class BoxMullerGaussianSampler
extends SamplerBase
implements ContinuousSampler

Deprecated.

Since version 1.1. Please use BoxMullerNormalizedGaussianSampler and GaussianSampler instead.

Box-Muller algorithm for sampling from a Gaussian distribution.

Sampling uses:

• UniformRandomProvider.nextDouble()
• UniformRandomProvider.nextLong()

Since:

1.0

Constructor Summary

Constructors

Constructor	Description
BoxMullerGaussianSampler(UniformRandomProvider rng, double mean, double standardDeviation)	Deprecated. Create an instance.

Method Summary

Modifier and Type	Method	Description
double	sample()	Deprecated. Creates a double sample.
String	toString()	Deprecated.

Methods inherited from class SamplerBase

nextDouble, nextInt, nextInt, nextLong

Methods inherited from class Object

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

Methods inherited from interface ContinuousSampler

samples, samples

Constructor Details

BoxMullerGaussianSampler

public BoxMullerGaussianSampler(UniformRandomProvider rng,
 double mean,
 double standardDeviation)

Deprecated.

Create an instance.

Parameters:

rng - Generator of uniformly distributed random numbers.

mean - Mean of the Gaussian distribution.

standardDeviation - Standard deviation of the Gaussian distribution.

Throws:

IllegalArgumentException - if standardDeviation <= 0

Method Details

sample

public double sample()

Deprecated.

Creates a double sample.

Specified by:

sample in interface ContinuousSampler

Returns:

a sample.

toString

public String toString()

Deprecated.

Overrides:

toString in class SamplerBase