desmoj.core.dist

Class ContDistGamma

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

public class ContDistGamma
extends ContDist

Distribution returning gamma distributed double values.

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
ContDistGamma(Model owner, java.lang.String name, double alpha, double beta, boolean showInReport, boolean showInTrace) Creates a stream of pseudo random numbers following a gamma distribution.

Method Summary

Modifier and Type	Method and Description
Reporter	createDefaultReporter() Creates the default reporter for the GammaDist distribution.
double	getAlpha()
double	getBeta()
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.
java.lang.Double	sample() Returns the next 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

ContDistGamma

public ContDistGamma(Model owner,
                     java.lang.String name,
                     double alpha,
                     double beta,
                     boolean showInReport,
                     boolean showInTrace)

Creates a stream of pseudo random numbers following a gamma distribution. The specific parameters alpha and beta have to be given here at creation time.

Parameters:

owner - Model : The distribution's owner

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

alpha - double: Distribution specific shape parameter alpha

beta - double : Distribution specific scale parameter beta

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

Overrides:

createDefaultReporter in class Distribution

Returns:

Reporter : The reporter for the GammaDist distribution

See Also:

ContDistGammaReporter

getAlpha

public double getAlpha()

Returns:

double : Distribution specific shape parameter alpha

getBeta

public double getBeta()

Returns:

double : Distribution specific scale parameter beta

sample

public java.lang.Double 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 alpha and beta parameters specified for this distribution.

Overrides:

sample in class NumericalDist<java.lang.Double>

Returns:

Double : The next gamma distributed sample from this distribution.

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:

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