desmoj.core.dist

Class DiscreteDistPoisson

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.dist.Distribution

desmoj.core.dist.NumericalDist<N>

desmoj.core.dist.DiscreteDist<java.lang.Long>

desmoj.core.dist.DiscreteDistPoisson

public class DiscreteDistPoisson
extends DiscreteDist<java.lang.Long>

Poisson distributed stream of pseudo random integer numbers. The distribution specified by one parameter describing the mean value.

Version:

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

Author:

Tim Lechler, Ruth Meyer 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
DiscreteDistPoisson(Model owner, java.lang.String name, double meanValue, boolean showInReport, boolean showInTrace) Creates a poisson distributed stream of pseudo random integer numbers.

Method Summary

Modifier and Type	Method and Description
Reporter	createDefaultReporter() Creates the default reporter for the PoissonDiscreteDist distribution.
java.lang.Long	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 poisson distribution.
java.lang.Long	sample() Returns the next poisson distributed sample from this distribution.

Methods inherited from class desmoj.core.dist.NumericalDist

sampleObject, sampleTimeSpan, sampleTimeSpan

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

DiscreteDistPoisson

public DiscreteDistPoisson(Model owner,
                           java.lang.String name,
                           double meanValue,
                           boolean showInReport,
                           boolean showInTrace)

Creates a poisson distributed stream of pseudo random integer numbers. The parameter describes the mean value. Giving zero or negative values for the mean value will result in zero being returned by the sample() method.

Parameters:

owner - Model : The distribution's owner

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

meanValue - double : The mean double 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 PoissonDiscreteDist distribution.

Overrides:

createDefaultReporter in class Distribution

Returns:

Reporter : The reporter for the PoissonDiscreteDist distribution

See Also:

DiscreteDistPoissonReporter

getMean

public double getMean()

Returns the mean value of the poisson distribution.

Returns:

double : The mean value of this Poisson distribution

sample

public java.lang.Long sample()

Returns the next poisson distributed sample from this distribution.

Overrides:

sample in class NumericalDist<java.lang.Long>

Returns:

Long : The next Poisson distributed sample. This will be zero if the given mean value <= 0.

getInverseOfCumulativeProbabilityFunction

public java.lang.Long 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.Long>

Parameters:

p - double: A value between 0 and 1

Returns:

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