BoxMullerLogNormalSampler (Apache Commons RNG Sampling 1.6 API)

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

Constructor Summary

Constructors
Constructor	Description
`BoxMullerLogNormalSampler(UniformRandomProvider rng, double mu, double sigma)`	Deprecated. Create an instance.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`double`	`sample()`	Deprecated. Creates a `double` 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

Methods inherited from interface org.apache.commons.rng.sampling.distribution.ContinuousSampler
samples, samples

- Constructor Detail
  - 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 Detail
  - 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