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.

Since version 1.1. Please use LogNormalSampler instead.

@Deprecated
public class BoxMullerLogNormalSampler
extends SamplerBase
implements ContinuousSampler

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(org.apache.commons.rng.UniformRandomProvider rng, double scale, double shape)	Deprecated.

Method Summary

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

Methods inherited from class java.lang.Object

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

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

nextDouble, nextInt, nextInt, nextLong

Constructor Detail

BoxMullerLogNormalSampler

public BoxMullerLogNormalSampler(org.apache.commons.rng.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:

java.lang.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 java.lang.String toString()

Deprecated.

Overrides:

toString in class SamplerBase