desmoj.core.dist

Class DiscreteDistGeo

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.DiscreteDistGeo

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

Distribution returning Geometrically distributed int values. The Geometrical distribution describes the probability of having a certain waiting time for the first success in a series of indepedent Bernoulli experiments, all having the same success probability.

Note: The generated values are not the amount of experiments done to get the first success, but the amount of failures before the first success.

Version:

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

Author:

Peter Wueppen 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
DiscreteDistGeo(Model owner, java.lang.String name, double probability, boolean showInReport, boolean showInTrace) Creates a stream of pseudo random numbers following a Geometrical distribution.

Method Summary

Modifier and Type	Method and Description
Reporter	createDefaultReporter() Creates the default reporter for the DiscreteDistGeo 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	getProbability() Returns the success probability in each separate Bernoulli experiment.
java.lang.Long	sample() Returns the next 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

DiscreteDistGeo

public DiscreteDistGeo(Model owner,
                       java.lang.String name,
                       double probability,
                       boolean showInReport,
                       boolean showInTrace)

Creates a stream of pseudo random numbers following a Geometrical distribution. The specific parameter p (probability) has to be given here at creation time.

Parameters:

owner - Model : The distribution's owner

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

probability - double : The probability of success in each separate Bernoulli experiment.

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

Overrides:

createDefaultReporter in class Distribution

Returns:

Reporter : The reporter for the DiscreteDistGeo distribution

See Also:

DistributionReporter

getProbability

public double getProbability()

Returns the success probability in each separate Bernoulli experiment.

Returns:

double : The success probability in each separate Bernoulli experiment.

sample

public java.lang.Long sample()

Returns the next sample from this distribution. The value depends upon the seed, the number of values taken from the stream by using this method before and the probability specified for this distribution.

Overrides:

sample in class NumericalDist<java.lang.Long>

Returns:

Long : The next Geometrically distributed sample from this distribution.

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