desmoj.core.dist

Class NumericalDist<N extends java.lang.Number>

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.dist.Distribution

desmoj.core.dist.NumericalDist<N>

Direct Known Subclasses:

ContDist, DiscreteDist

public abstract class NumericalDist<N extends java.lang.Number>
extends Distribution

Base class for all distributions that produce numbers.

Version:

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

Author:

Tim Lechler 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
NumericalDist(Model owner, java.lang.String name, boolean showInReport, boolean showInTrace)

Method Summary

Modifier and Type	Method and Description
abstract N	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.
N	sample() Method to return the specific sample as a value of type N.
java.lang.Object	sampleObject() Convenience method to return the distribution's sample as Object.
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.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

NumericalDist

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

Method Detail

sample

public N sample()

Method to return the specific sample as a value of type N. Default implementation calls getInverseCumulativeProbability(), to which a random number from randomGenerator is passed. Subclasses may need to refine this method if getInverseCumulativeProbability() is not implemented as the distribution does not support inverse transformation.

Returns:

N : The sample of type N to be drawn from this distribution

getInverseOfCumulativeProbabilityFunction

public abstract N 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.

Parameters:

p - double: A value between 0 and 1

Returns:

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

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()).

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

Parameters:

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

Returns:

TimeSpan : The TimeSpan sampled from this distribution

sampleObject

public java.lang.Object sampleObject()

Convenience method to return the distribution's sample as Object. For type safety, method sample() should be preferred. However, this method is useful for environments requiring a non-genetic access point to obtain samples from any distribution.

Specified by:

sampleObject in class Distribution

Returns:

Object : A sample from this this distribution wrapped as Object.