Package org.apache.commons.rng.sampling.distribution

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().

Since:

1.0

Constructor Summary

Constructors

Constructor	Description
BoxMullerLogNormalSampler(UniformRandomProvider rng, double scale, double shape)	Deprecated.

Method Summary

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

Methods inherited from class org.apache.commons.rng.sampling.distribution.SamplerBase

nextDouble, nextInt, nextInt, nextLong

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxMullerLogNormalSampler

public BoxMullerLogNormalSampler(UniformRandomProvider rng,
                                 double scale,
                                 double shape)

Deprecated.

Parameters:

rng - Generator of uniformly distributed random numbers.

scale - Scale of the log-normal distribution.

shape - Shape of the log-normal distribution.

Throws:

IllegalArgumentException - if scale < 0 or shape <= 0.

Method Detail

sample

public double sample()

Deprecated.

Creates a sample.

Specified by:

sample in interface ContinuousSampler

Returns:

a sample.

toString

public String toString()

Deprecated.

Overrides:

toString in class SamplerBase