desmoj.core.dist

Class ContDistExponential

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

Direct Known Subclasses:

ContDistErlang, ContDistWeibull

public class ContDistExponential
extends ContDist

Negative-exponentially distributed stream of pseudo random numbers of type double.

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
ContDistExponential(Model owner, java.lang.String name, double mean, boolean showInReport, boolean showInTrace) Constructs a simple negative-exponentially distributed pseudo random generator with the given value as mean of the distribution.

Method Summary

Modifier and Type	Method and Description
Reporter	createDefaultReporter() Creates the default reporter for the RealDistExponential 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 the negative-exponential distribution.
java.lang.Double	sample() Returns the next negative exponential pseudo random number.

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

ContDistExponential

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

Constructs a simple negative-exponentially distributed pseudo random generator with the given value as mean of the distribution. Only positive values are allowed.

Parameters:

owner - Model : The distribution's owner

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

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 RealDistExponential distribution.

Overrides:

createDefaultReporter in class Distribution

Returns:

Reporter : The reporter for the RealDistExponential distribution

See Also:

ContDistExponReporter

getMean

public double getMean()

Returns the mean value of the negative-exponential distribution.

Returns:

double : the mean value of the negative-exponential distribution

sample

public java.lang.Double sample()

Returns the next negative exponential pseudo random number.

Overrides:

sample in class NumericalDist<java.lang.Double>

Returns:

Double : The next negative exponential pseudo random number

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.

Specified by:

getInverseOfCumulativeProbabilityFunction in class NumericalDist<java.lang.Double>

Parameters:

p - double: A value between 0 and 1

Returns:

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