desmoj.core.dist

Class ContDistTriangular

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

public class ContDistTriangular
extends ContDist

Distribution returning triangular 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
ContDistTriangular(Model owner, java.lang.String name, double lower, double upper, double peak, boolean showInReport, boolean showInTrace) Creates a stream of pseudo random numbers following a triangular distribution.

Method Summary

Modifier and Type	Method and Description
Reporter	createDefaultReporter() Creates the default reporter for the TriangularDist 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	getLower() Returns the minimum value of this triangular distribution.
double	getPeak() Returns the most likely value of this triangular distribution.
double	getUpper() Returns the maximum value of this triangular 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

ContDistTriangular

public ContDistTriangular(Model owner,
                          java.lang.String name,
                          double lower,
                          double upper,
                          double peak,
                          boolean showInReport,
                          boolean showInTrace)

Creates a stream of pseudo random numbers following a triangular distribution. The specific lower and upper bounds as well as the most probable value have to be given here at creation time.

Parameters:

owner - Model : The distribution's owner

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

lower - double : The lowest possibly generated value.

upper - double : The highest possibly generated value.

peak - double : The most probable value within the distribution, the peak of the triangle.

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

Overrides:

createDefaultReporter in class Distribution

Returns:

Reporter : The reporter for the TriangularDist distribution

See Also:

ContDistTriangularReporter

getLower

public double getLower()

Returns the minimum value of this triangular distribution.

Returns:

double : The minimum value of this triangular distribution

getUpper

public double getUpper()

Returns the maximum value of this triangular distribution.

Returns:

double : The maximum value of this triangular distribution

getPeak

public double getPeak()

Returns the most likely value of this triangular distribution.

Returns:

double : The most likely value of this triangular distribution

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 lower and upper bounds as well as the peak value specified for this distribution.

Overrides:

sample in class NumericalDist<java.lang.Double>

Returns:

Double : The next triangular 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