desmoj.core.dist

Class DiscreteDistUniform

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.dist.Distribution

desmoj.core.dist.NumericalDist<N>

desmoj.core.dist.DiscreteDist<java.lang.Long>

desmoj.core.dist.DiscreteDistUniform

public class DiscreteDistUniform
extends DiscreteDist<java.lang.Long>

Uniformly distributed stream of pseudo random numbers of type long. Values produced by this distribution are uniformly distributed in the range specified as parameters of the constructor.

Version:

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

Author:

Tim Lechler, modified by Philip Joschko 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.

See Also:

Distribution

Constructor Summary

Constructors

Constructor and Description
DiscreteDistUniform(Model owner, java.lang.String name, long minValue, long maxValue, boolean showInReport, boolean showInTrace) Creates a stream of pseudo random numbers following a uniform distribution.

Method Summary

Modifier and Type	Method and Description
Reporter	createDefaultReporter() Creates the default reporter for the UniformDiscreteDist distribution.
java.lang.Long	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.
long	getLower() Returns the lower border of the range of this distribution.
long	getUpper() Returns the upper border of the range of this distribution.
java.lang.Long	sample() Returns the next uniformly distributed integer sample.
void	setNonNegative(boolean newValue) Overrides the same method of desmoj.dist.Distribution.

Methods inherited from class desmoj.core.dist.NumericalDist

sampleObject, sampleTimeSpan, sampleTimeSpan

Methods inherited from class desmoj.core.dist.Distribution

changeRandomGenerator, getInitialSeed, getNonNegative, getNumSamples, isAntithetic, reset, reset, setAntithetic, 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

DiscreteDistUniform

public DiscreteDistUniform(Model owner,
                           java.lang.String name,
                           long minValue,
                           long maxValue,
                           boolean showInReport,
                           boolean showInTrace)

Creates a stream of pseudo random numbers following a uniform distribution. The specific lower and upper borders of the range of this distribution have to be given here at creation time. Note that the lower border in fact has to be lower than the upper border. If not, the parameters will be swapped to assign the higher value to the upper border of the distribution. Two equal values for upper and lower will be accepted, but result in a constant distribution that will invariabbly return that given value. In both cases a warning mesage will be produced.
Note that the range, i.e. the difference between the upper and lower border, must be less than Long.MAX_VALUE for arithmetic reasons.

Parameters:

owner - Model : The distribution's owner

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

minValue - long : The minimum value for this distribution

maxValue - long : The maximum value for this distribution

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

Overrides:

createDefaultReporter in class Distribution

Returns:

Reporter : The reporter for the UniformDiscreteDist distribution

See Also:

DiscreteDistUniformReporter

getLower

public long getLower()

Returns the lower border of the range of this distribution.

Returns:

long : The lower border of the random number's range

getUpper

public long getUpper()

Returns the upper border of the range of this distribution.

Returns:

long : The upper border of the random number's range

sample

public java.lang.Long sample()

Returns the next uniformly distributed integer sample. The value returned is basically the uniformly distributed pseudo random number produced by the underlying random generator stretched to match the range specified by the client via constructor parameters.

Overrides:

sample in class NumericalDist<java.lang.Long>

Returns:

Long : The next uniformly distributed sample

getInverseOfCumulativeProbabilityFunction

public java.lang.Long 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.Long>

Parameters:

p - double: A value between 0 and 1

Returns:

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

setNonNegative

public void setNonNegative(boolean newValue)

Overrides the same method of desmoj.dist.Distribution. It makes no sense to set a UniformDiscreteDist object with a negative lower border to nonNegative. In this case a warning will be sent.
Sets the nonNegative switch to the given value. If nonNegative is set to true the distribution returns positive samples only, otherwise it also produces negative samples, if possible.

Overrides:

setNonNegative in class Distribution

Parameters:

newValue - boolean : If true the distribution is set to return positive samples only, otherwise it also produces negative samples, if possible.