InverseTransformParetoSampler (VirtualDataSet API)

java.lang.Object
- org.apache.commons.rng.sampling.distribution.SamplerBase
- - org.apache.commons.rng.sampling.distribution.InverseTransformParetoSampler

All Implemented Interfaces:

ContinuousSampler
```
public class InverseTransformParetoSampler
extends SamplerBase
implements ContinuousSampler
```
Sampling from a Pareto distribution.
Sampling uses UniformRandomProvider.nextDouble().

Since:

1.0

- Constructor Summary
  
  Constructors
  Constructor Description
  
  InverseTransformParetoSampler(UniformRandomProvider rng, double scale, double shape)
- Method Summary
  
  Modifier and Type Method Description
  
  double sample()
  Creates a sample.
  
  java.lang.String toString()
  - 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
  - InverseTransformParetoSampler
```
public InverseTransformParetoSampler(UniformRandomProvider rng,
                                     double scale,
                                     double shape)
```
    Parameters:
    
    rng - Generator of uniformly distributed random numbers.
    
    scale - Scale of the distribution.
    
    shape - Shape of the distribution.
    
    Throws:
    
    java.lang.IllegalArgumentException - if scale <= 0 or shape <= 0
- Method Detail
  - sample
```
public double sample()
```
    Creates a sample.
    
    Specified by:
    
    sample in interface ContinuousSampler
    
    Returns:
    
    a sample.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class SamplerBase