desmoj.core.dist

Class ContDistUniform

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

public class ContDistUniform
extends ContDist

Uniformly distributed stream of pseudo random numbers of type double. 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 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
ContDistUniform(Model owner, java.lang.String name, double lowerBorder, double upperBorder, boolean showInReport, boolean showInTrace) Creates a stream of pseudo random numbers following a uniform distribution between the lower and the upper value parameter.

Method Summary

Modifier and Type	Method and Description
Reporter	createDefaultReporter() Creates the default reporter for the RealDistUniform 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 lower border of the range of this uniform distribution.
double	getUpper() Returns the upper border of the range of this distribution.
java.lang.Double	sample() Returns the next floating point sample from this uniform distribution.
void	setNonNegative(boolean newValue) Overrides the same method of desmoj.dist.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, 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

ContDistUniform

public ContDistUniform(Model owner,
                       java.lang.String name,
                       double lowerBorder,
                       double upperBorder,
                       boolean showInReport,
                       boolean showInTrace)

Creates a stream of pseudo random numbers following a uniform distribution between the lower and the upper value parameter. 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 invariably return that given value.

Parameters:

owner - Model : The distribution's owner

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

lowerBorder - double : The minimum value for this distribution

upperBorder - double : 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 RealDistUniform distribution.

Overrides:

createDefaultReporter in class Distribution

Returns:

Reporter : The reporter for the RealDistUniform distribution

See Also:

ContDistUniformReporter

getLower

public double getLower()

Returns the lower border of the range of this uniform distribution.

Returns:

double : The lower border of the range of this uniform distribution

getUpper

public double getUpper()

Returns the upper border of the range of this distribution.

Returns:

double : The upper border of the range of this uniform distribution

sample

public java.lang.Double sample()

Returns the next floating point sample from this uniform distribution. 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 construtor parameters.

Overrides:

sample in class NumericalDist<java.lang.Double>

Returns:

Double : The next floating point sample from this uniform 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

setNonNegative

public void setNonNegative(boolean newValue)

Overrides the same method of desmoj.dist.Distribution. It makes no sense to set a RealDistUniform 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.