PearsonType5RV (JSLAll 1.0-SNAPSHOT API)

java.lang.Object
- jsl.utilities.random.rvariable.AbstractRVariable
- - jsl.utilities.random.rvariable.PearsonType5RV

All Implemented Interfaces:

java.util.function.DoubleSupplier, GetNameIfc, GetValueIfc, IdentityIfc, PreviousValueIfc, RandomIfc, GetRandomNumberStreamIfc, RNStreamControlIfc, SetRandomNumberStreamIfc, NewAntitheticInstanceIfc, RVariableIfc, SampleIfc
```
public final class PearsonType5RV
extends AbstractRVariable
```
Pearson Type 5(shape, scale) random variable

Nested Class Summary
- Nested classes/interfaces inherited from interface jsl.utilities.random.rvariable.RVariableIfc
  RVariableIfc.RVType

Field Summary
- Fields inherited from class jsl.utilities.random.rvariable.AbstractRVariable
  myRNStream

Constructor Summary

Constructors
Constructor	Description
`PearsonType5RV(double shape, double scale)`
`PearsonType5RV(double shape, double scale, int streamNum)`
`PearsonType5RV(double shape, double scale, RNStreamIfc rng)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected double`	`generate()`
`double`	`getScale()`	Gets the scale parameter
`double`	`getShape()`	Gets the shape
`static RVControls`	`makeControls()`	The keys are "shape" with default value 1.0 and "scale" with default value 1.0
`PearsonType5RV`	`newInstance(RNStreamIfc rng)`
`java.lang.String`	`toString()`

Methods inherited from class jsl.utilities.random.rvariable.AbstractRVariable
advanceToNextSubstream, getAntitheticOption, getId, getName, getPreviousValue, getRandomNumberStream, getValue, newAntitheticInstance, newInstance, resetStartStream, resetStartSubstream, sample, setAntitheticOption, setName, setPreviousValue, setRandomNumberStream

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface jsl.utilities.random.rng.GetRandomNumberStreamIfc
getStreamNumber

Methods inherited from interface jsl.utilities.random.rvariable.RVariableIfc
asDoubleStream, getAsDouble, getSumOfValues, newInstance

Methods inherited from interface jsl.utilities.random.SampleIfc
sample, sample

Methods inherited from interface jsl.utilities.random.rng.SetRandomNumberStreamIfc
setRandomNumberStream

- Constructor Detail
  - PearsonType5RV
```
public PearsonType5RV(double shape,
                      double scale)
```
  - PearsonType5RV
```
public PearsonType5RV(double shape,
                      double scale,
                      int streamNum)
```
  - PearsonType5RV
```
public PearsonType5RV(double shape,
                      double scale,
                      RNStreamIfc rng)
```
- Method Detail
  - newInstance
```
public PearsonType5RV newInstance(RNStreamIfc rng)
```
    Parameters:
    
    rng - the RngIfc to use
    
    Returns:
    
    a new instance with same parameter value
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getShape
```
public double getShape()
```
    Gets the shape
    
    Returns:
    
    The shape parameter as a double
  - getScale
```
public double getScale()
```
    Gets the scale parameter
    
    Returns:
    
    The scale parameter as a double
  - generate
```
protected double generate()
```
    Specified by:
    
    generate in class AbstractRVariable
    
    Returns:
    
    the randomly generated variate
  - makeControls
```
public static RVControls makeControls()
```
    The keys are "shape" with default value 1.0 and "scale" with default value 1.0
    
    Returns:
    
    a control for PearsonType5 random variables