desmoj.core.dist

Class ContDist

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

Direct Known Subclasses:

ContDistAggregate, ContDistBeta, ContDistConstant, ContDistCustom, ContDistEmpirical, ContDistExponential, ContDistGamma, ContDistNormal, ContDistTriangular, ContDistUniform

public abstract class ContDist
extends NumericalDist<java.lang.Double>

Superclass for all distributions returning (near-)continuous samples of type Double.

Version:

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

Author:

Tim Lechler, Johannes Goebel 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
ContDist(Model owner, java.lang.String name, boolean showInReport, boolean showInTrace) Constructs a distribution returning continuously distributed double samples.

Method Summary

Modifier and Type	Method and Description
TimeSpan	sampleTimeSpan() Convenience method to sample a period of random length by creating a TimeSpan whose length is determined by sampling this distribution (time unit is the experiment's reference units), thus replacing the pattern new TimeSpan(distribution.sample()).
TimeSpan	sampleTimeSpan(java.util.concurrent.TimeUnit unit) Convenience method to sample a period of random length by creating a TimeSpan whose length is determined by sampling this distribution (time unit given explicitly as parameter), thus replacing the pattern new TimeSpan(distribution.sample(), unit).

Methods inherited from class desmoj.core.dist.NumericalDist

getInverseOfCumulativeProbabilityFunction, sample, sampleObject

Methods inherited from class desmoj.core.dist.Distribution

changeRandomGenerator, createDefaultReporter, 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

ContDist

public ContDist(Model owner,
                java.lang.String name,
                boolean showInReport,
                boolean showInTrace)

Constructs a distribution returning continuously distributed double samples. Note that the method Double sample() returning the samples (inherited from NumericalDist) has to be implemented in subclasses.

Parameters:

owner - Model : The distribution's owner

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

showInReport - boolean : Flag to show distribution in report

showInTrace - boolean : Flag to show distribution in trace

Method Detail

sampleTimeSpan

public TimeSpan sampleTimeSpan()

Convenience method to sample a period of random length by creating a TimeSpan whose length is determined by sampling this distribution (time unit is the experiment's reference units), thus replacing the pattern new TimeSpan(distribution.sample()).

Overrides:

sampleTimeSpan in class NumericalDist<java.lang.Double>

Returns:

TimeSpan : The TimeSpan sampled from this distribution

sampleTimeSpan

public TimeSpan sampleTimeSpan(java.util.concurrent.TimeUnit unit)

Convenience method to sample a period of random length by creating a TimeSpan whose length is determined by sampling this distribution (time unit given explicitly as parameter), thus replacing the pattern new TimeSpan(distribution.sample(), unit).

Overrides:

sampleTimeSpan in class NumericalDist<java.lang.Double>

Parameters:

unit - TimeUnit: the TimeUnit to assign to the sampled value

Returns:

TimeSpan : The TimeSpan sampled from this distribution