desmoj.core.dist

Class ContDistErlang

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.dist.Distribution

desmoj.core.dist.NumericalDist<java.lang.Double>

desmoj.core.dist.ContDist

desmoj.core.dist.ContDistExponential

desmoj.core.dist.ContDistErlang

public class ContDistErlang
extends ContDistExponential

Erlang distributed stream of pseudo random numbers of type double. Erlang distributed streams are specified by a mean value and their order.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Tim Lechler Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Constructor Summary

Constructors

Constructor and Description
ContDistErlang(Model owner, java.lang.String name, long order, double mean, boolean showInReport, boolean showInTrace) Creates a stream of pseudo random numbers following a normal (a.k.a.

Method Summary

Modifier and Type	Method and Description
Reporter	createDefaultReporter() Creates the default reporter for the RealDistErlang distribution.
java.lang.Double	getInverseOfCumulativeProbabilityFunction(double p) Abstract method to map a double p from 0...1 to the distribution's domain by determining the value x that satisfies P(X < x) = p.
double	getMean() Returns the mean value of this Erlang distribution.
long	getOrder() Returns the order of the Erlang distribution.
java.lang.Double	sample() Returns the next Erlang distributed sample from this distribution.

Methods inherited from class desmoj.core.dist.ContDist

sampleTimeSpan, sampleTimeSpan

Methods inherited from class desmoj.core.dist.NumericalDist

sampleObject

Methods inherited from class desmoj.core.dist.Distribution

changeRandomGenerator, getInitialSeed, getNonNegative, getNumSamples, isAntithetic, reset, reset, setAntithetic, setNonNegative, setSeed

Methods inherited from class desmoj.core.simulator.Reportable

getCorrespondingSchedulable, getDescription, getObservations, getReporter, incrementObservations, incrementObservations, reportIsOn, reportOff, reportOn, resetAt, setCorrespondingSchedulable, setDescription, setReporter

Methods inherited from class desmoj.core.simulator.ModelComponent

current, currentEntity, currentEntityAll, currentEvent, currentModel, currentSimProcess, debugIsOn, debugOff, debugOn, getModel, isExperimentCompatible, isModelCompatible, presentTime, sendDebugNote, sendMessage, sendTraceNote, sendWarning, skipTraceNote, skipTraceNote, traceIsOn, traceOff, traceOn

Methods inherited from class desmoj.core.simulator.NamedObject

getName, getQuotedName, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ContDistErlang

public ContDistErlang(Model owner,
                      java.lang.String name,
                      long order,
                      double mean,
                      boolean showInReport,
                      boolean showInTrace)

Creates a stream of pseudo random numbers following a normal (a.k.a. "Gaussian") distribution. The specific mean and standard deviation values have to be given here at creation time, as well as the seed for the underlying pseudo random generator.

Parameters:

owner - Model : The distribution's owner

name - java.lang.String : The distribution's name

order - long : The order of the Erlang distribution (>=1)

mean - double : The mean value for this distribution

showInReport - boolean : Flag for producing reports

showInTrace - boolean : Flag for producing trace output

Method Detail

createDefaultReporter

public Reporter createDefaultReporter()

Creates the default reporter for the RealDistErlang distribution.

Overrides:

createDefaultReporter in class ContDistExponential

Returns:

Reporter : The reporter for the RealDistErlang distribution

See Also:

ContDistErlangReporter

getMean

public double getMean()

Returns the mean value of this Erlang distribution.

Overrides:

getMean in class ContDistExponential

Returns:

double : The mean value of this Erlang distribution.

getOrder

public long getOrder()

Returns the order of the Erlang distribution.

Returns:

double : The order of this Erlang distribution.

sample

public java.lang.Double sample()

Returns the next Erlang distributed sample from this distribution. The algorithm used is taken from DESMO-C from Thomas Schniewind [Schni98] Volume 2, page 222, file realdist.cc. It has been adapted to Java and extended to handle antithetic random numbers if antithetic mode is switched on.

Overrides:

sample in class ContDistExponential

Returns:

Double : The next Erlang distributed sample

getInverseOfCumulativeProbabilityFunction

public java.lang.Double getInverseOfCumulativeProbabilityFunction(double p)

Abstract method to map a double p from 0...1 to the distribution's domain by determining the value x that satisfies P(X < x) = p.

Overrides:

getInverseOfCumulativeProbabilityFunction in class ContDistExponential

Parameters:

p - double: A value between 0 and 1

Returns:

Double : The value x that satisfies P(X < x) = p