Class BoxMullerLogNormalSampler

java.lang.Object

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

org.apache.commons.rng.sampling.distribution.BoxMullerLogNormalSampler

All Implemented Interfaces:

ContinuousSampler

@Deprecated
public class BoxMullerLogNormalSampler
extends SamplerBase
implements ContinuousSampler

Deprecated.

Since version 1.1. Please use LogNormalSampler instead.

Sampling from a log-normal distribution. Uses BoxMullerNormalizedGaussianSampler as the underlying sampler.

Sampling uses:

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

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
private final ContinuousSampler	sampler	Deprecated. Delegate.

Constructor Summary

Constructors

Constructor	Description
BoxMullerLogNormalSampler(UniformRandomProvider rng, double mu, double sigma)	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

Field Details

sampler

private final ContinuousSampler sampler

Deprecated.

Delegate.

Constructor Details

BoxMullerLogNormalSampler

public BoxMullerLogNormalSampler(UniformRandomProvider rng,
 double mu,
 double sigma)

Deprecated.

Create an instance.

Parameters:

rng - Generator of uniformly distributed random numbers.

mu - Mean of the natural logarithm of the distribution values.

sigma - Standard deviation of the natural logarithm of the distribution values.

Throws:

IllegalArgumentException - if sigma <= 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