desmoj.core.dist

Class ContDistCustom

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

Type Parameters:

N -

public class ContDistCustom
extends ContDist

Distribution returning values according to a user-specified distribution function. It is important that the used function is an actual distribution function, meaning it must be strictly monotonically increasing from 0 to 1. You also need to specify the lower and upper bounds of the distribution, meaning the values at which the cumulative probability is 0 and 1 respectively. If these requirements are not fulfilled, the class might return false and/or no samples.

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
ContDistCustom(Model owner, java.lang.String name, Function function, double lower, double upper, boolean showInReport, boolean showInTrace) Instantiates the CustomContDist, making it possible to get samples.

Method Summary

Modifier and Type	Method and Description
Reporter	createDefaultReporter() Creates the default reporter for the CustomContDist distribution.
Function	getFunction() Returns the upper bound of possible values of this 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	getLowerBound() Returns the lower bound of possible values of this distribution.
double	getUpperBound() Returns the upper bound of possible values of this distribution.
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

ContDistCustom

public ContDistCustom(Model owner,
                      java.lang.String name,
                      Function function,
                      double lower,
                      double upper,
                      boolean showInReport,
                      boolean showInTrace)

Instantiates the CustomContDist, making it possible to get samples. The user-defined CustomFunction has to be given here.

Parameters:

owner - Model : The distribution's owner

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

function - Function: User-defined distribution Function

showInReport - boolean : Flag for producing reports

showInTrace - boolean : Flag for producing trace output

Method Detail

getLowerBound

public double getLowerBound()

Returns the lower bound of possible values of this distribution.

Returns:

double : The lower bound of possible values of this distribution.

getUpperBound

public double getUpperBound()

Returns the upper bound of possible values of this distribution.

Returns:

double : The upper bound of possible values of this distribution.

getFunction

public Function getFunction()

Returns the upper bound of possible values of this distribution.

Returns:

double : The upper bound of possible values of this distribution.

createDefaultReporter

public Reporter createDefaultReporter()

Creates the default reporter for the CustomContDist distribution.

Overrides:

createDefaultReporter in class Distribution

Returns:

Reporter : The reporter for the CustomContDist distribution

See Also:

ContDistCustomReporter

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:

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