desmoj.core.dist

Class DiscreteDistConstant<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>

desmoj.core.dist.DiscreteDist<N>

desmoj.core.dist.DiscreteDistConstant<N>

public class DiscreteDistConstant<N extends java.lang.Number>
extends DiscreteDist<N>

This constant "pseudo"-distribution returns a single constant predefined value of type N. This "distribution" is most useful for testing purposes. The value to be returned can be specified at construction time.

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.

See Also:

Distribution

Constructor Summary

Constructors

Constructor and Description
DiscreteDistConstant(Model owner, java.lang.String name, N constantValue, boolean showInReport, boolean showInTrace) Constructs a simple distribution which produces samples equal to the constant value it has been given.

Method Summary

Modifier and Type	Method and Description
Reporter	createDefaultReporter() Creates the default reporter for the constant distribution.
N	getConstantValue() Returns the constant value associated with this ConstantDiscreteDist distribution
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() Returns the next constant sample of this distribution.
void	setConstant(N newValue) Changes the constant value to the new one specified.
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

DiscreteDistConstant

public DiscreteDistConstant(Model owner,
                            java.lang.String name,
                            N constantValue,
                            boolean showInReport,
                            boolean showInTrace)

Constructs a simple distribution which produces samples equal to the constant value it has been given.

Parameters:

owner - Model : The distribution's owner

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

constantValue - N : The constant value produced by 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 constant distribution.

Overrides:

createDefaultReporter in class Distribution

Returns:

Reporter : The reporter for the constant distribution

See Also:

DistributionReporter

getConstantValue

public N getConstantValue()

Returns the constant value associated with this ConstantDiscreteDist distribution

Returns:

N : The constant value returned by this ConstantDiscreteDist distribution

sample

public N sample()

Returns the next constant sample of this distribution. For this "pseudo"-distribution it is always is the default value specified through the constructor or via the setConstant method.

Overrides:

sample in class NumericalDist<N extends java.lang.Number>

Returns:

N : The constant sample

getInverseOfCumulativeProbabilityFunction

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

Specified by:

getInverseOfCumulativeProbabilityFunction in class NumericalDist<N extends java.lang.Number>

Parameters:

p - double: A value between 0 and 1

Returns:

N : The constant value

setConstant

public void setConstant(N newValue)

Changes the constant value to the new one specified.

Parameters:

newValue - N : the new value to be returned by this pseudo distribution

setNonNegative

public void setNonNegative(boolean newValue)

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