ikr.simlib.distributions.discrete.transform

Class FlooredDistribution

java.lang.Object

ikr.simlib.distributions.Distribution

ikr.simlib.distributions.discrete.DiscreteDistribution

ikr.simlib.distributions.discrete.transform.FlooredDistribution

All Implemented Interfaces:

ReflectionConstructable, ReflectionConstructable3<SimNode,Parameters,RandomNumberGenerator>

public class FlooredDistribution
extends DiscreteDistribution

Floored Distribution

Meaning:	The "floored distribution" is a discrete distribution that converts the value obtained from a continuous ("base") distribution to an integer value using the floor() function from the Java Math package. floor(x) implements the floor operator \(\left \lfloor x \right \rfloor\), i.e. it yields the largest integer value not greater than \(x\).
Parameters:	continuous base distribution \(f(x)\) (DF \(F(x)\))
Distribution:	\(P(X=i) = F(i+1)-F(i)\)
Parser example:	[...].Distribution = FlooredDistribution [...].Distribution.BaseDist = NegExp [...].Distribution.BaseDist.Mean = 2.5

Field Summary

Fields

Modifier and Type	Field and Description
ContinuousDistribution	baseDist

Fields inherited from class ikr.simlib.distributions.Distribution

rng

Fields inherited from interface ikr.simlib.parameters.reflection.ReflectionConstructable

CREATE_INSTANCE_METHOD_NAME

Constructor Summary

Constructors

Constructor and Description
FlooredDistribution(ContinuousDistribution baseDist)

Method Summary

Methods

Modifier and Type	Method and Description
static FlooredDistribution	createInstance(SimNode ownNode, Parameters pars, RandomNumberGenerator rng) as required by ReflectionConstructable
int	next() Returns the floored value of the base distribution or Integer.MIN/MAX_VALUE if the value exceeds the integer range.

Methods inherited from class ikr.simlib.distributions.Distribution

getDefaultRNG, getRandomNumberGenerator, reset

Methods inherited from class java.lang.Object

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

Field Detail

baseDist

public final ContinuousDistribution baseDist

Constructor Detail

FlooredDistribution

public FlooredDistribution(ContinuousDistribution baseDist)

Method Detail

createInstance

public static FlooredDistribution createInstance(SimNode ownNode,
                                 Parameters pars,
                                 RandomNumberGenerator rng)

as required by ReflectionConstructable

next

public int next()

Returns the floored value of the base distribution or Integer.MIN/MAX_VALUE if the value exceeds the integer range.

Specified by:

next in class DiscreteDistribution