LevySampler (Apache Commons RNG Sampling 1.7 API)

java.lang.Object
- org.apache.commons.rng.sampling.distribution.LevySampler

All Implemented Interfaces:

ContinuousSampler, SharedStateContinuousSampler, SharedStateSampler<SharedStateContinuousSampler>
```
public final class LevySampler
extends Object
implements SharedStateContinuousSampler
```
Sampling from a Lévy distribution.

Since:

1.4

See Also:

Lévy distribution

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static LevySampler`	`of(org.apache.commons.rng.UniformRandomProvider rng, double location, double scale)`	Create a new Lévy distribution sampler.
`double`	`sample()`	Creates a `double` sample.
`String`	`toString()`
`LevySampler`	`withUniformRandomProvider(org.apache.commons.rng.UniformRandomProvider rng)`	Create a new instance of the sampler with the same underlying state using the given uniform random provider as the source of randomness.

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

- Method Detail
  - sample
```
public double sample()
```
    Creates a double sample.
    
    Specified by:
    
    sample in interface ContinuousSampler
    
    Returns:
    
    a sample.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - withUniformRandomProvider
```
public LevySampler withUniformRandomProvider(org.apache.commons.rng.UniformRandomProvider rng)
```
    Create a new instance of the sampler with the same underlying state using the given uniform random provider as the source of randomness.
    
    Specified by:
    
    withUniformRandomProvider in interface SharedStateSampler<SharedStateContinuousSampler>
    
    Parameters:
    
    rng - Generator of uniformly distributed random numbers.
    
    Returns:
    
    the sampler
  - of
```
public static LevySampler of(org.apache.commons.rng.UniformRandomProvider rng,
                             double location,
                             double scale)
```
    Create a new Lévy distribution sampler.
    
    Parameters:
    
    rng - Generator of uniformly distributed random numbers.
    
    location - Location of the Lévy distribution.
    
    scale - Scale of the Lévy distribution.
    
    Returns:
    
    the sampler
    
    Throws:
    
    IllegalArgumentException - if scale <= 0