sim.util.distribution

Class PiecewiseLinear

java.lang.Object

sim.util.distribution.AbstractDistribution

sim.util.distribution.AbstractContinousDistribution

sim.util.distribution.PiecewiseLinear

All Implemented Interfaces:

Serializable

public class PiecewiseLinear
extends AbstractContinousDistribution

Piecewise linear distribution mapping source intervals to target intervals. The intervals entries are evaluated in order as they were added, each one added to the sum of the previous ones. Shift and scale are applied last with interval values independent from them.

The cumulative distribution function (cdf) maps the accumulated range of source intervals to the accumulated range of target intervals times scale plus shift.

See Also:

Serialized Form

Field Summary

Fields inherited from class sim.util.distribution.AbstractDistribution

randomGenerator

Constructor Summary

Constructors

Constructor and Description
PiecewiseLinear(double scale, double shift, MersenneTwisterFast random) Constructs a new PiecewiseLinear distribution.
PiecewiseLinear(MersenneTwisterFast random) Constructs a new PiecewiseLinear distribution with neutral shift (1) and scale (0).

Method Summary

Modifier and Type	Method and Description
boolean	addInterval(double sourceIntervalMax, double targetIntervalMax) Adds an interval spanning from the maximum value of the previous interval to the given, mapping from source to target.
double	evaluateCdf(double x) Evaluates cumulative distribution function for this distribution.
double	getScale()
double	getShift()
double	nextDouble()
void	setScale(double scale)
void	setShift(double shift)
String	toString()

Methods inherited from class sim.util.distribution.AbstractDistribution

apply, apply, getRandomGenerator, nextInt, setRandomGenerator

Methods inherited from class java.lang.Object

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

Constructor Detail

PiecewiseLinear

public PiecewiseLinear(double scale,
                       double shift,
                       MersenneTwisterFast random)

Constructs a new PiecewiseLinear distribution.

Parameters:

scale - the scale of returned values

shift - the shift of returned values

random - the random number generator to be used

PiecewiseLinear

public PiecewiseLinear(MersenneTwisterFast random)

Constructs a new PiecewiseLinear distribution with neutral shift (1) and scale (0).

Parameters:

random - the random number generator to be used

Method Detail

addInterval

public boolean addInterval(double sourceIntervalMax,
                           double targetIntervalMax)

Adds an interval spanning from the maximum value of the previous interval to the given, mapping from source to target. Interval values are independent from shift and scale.

Parameters:

sourceIntervalMax -

targetIntervalMax -

Returns:

true (as specified by Collection.add(E))

evaluateCdf

public double evaluateCdf(double x)

Evaluates cumulative distribution function for this distribution. If the value exceeds [0,1] the result is either zero for the lower end or the maximum for the upper end.

Parameters:

x -

Returns:

result from function

getScale

public double getScale()

setScale

public void setScale(double scale)

getShift

public double getShift()

setShift

public void setShift(double shift)

nextDouble

public double nextDouble()

Specified by:

nextDouble in class AbstractDistribution

toString

public String toString()

Overrides:

toString in class Object