desmoj.core.dist

Class ContDistAggregate

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

public class ContDistAggregate
extends ContDist

Aggregate Distribution composed of a list of input Distributions. The operator between these to input distributions can be specified individually

Version:

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

Author:

Peter Wueppen 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
ContDistAggregate(Model owner, java.lang.String name, java.util.List<NumericalDist<?>> dists, Operator operator, boolean showInReport, boolean showInTrace) Creates a stream of pseudo random numbers following a distribution that is specified by a list of other distributions and an operator to aggregate them.
ContDistAggregate(Model owner, java.lang.String name, NumericalDist<?> dist1, NumericalDist<?> dist2, Operator operator, boolean showInReport, boolean showInTrace) Creates a stream of pseudo random numbers following a distribution that is specified by two other distributions and an operator to aggregate them.

Method Summary

Modifier and Type	Method and Description
Reporter	createDefaultReporter() Creates the default reporter for the ContDistAggregate distribution.
java.util.List<NumericalDist<?>>	getDists() Returns the first input distribution.
java.lang.Double	getInverseOfCumulativeProbabilityFunction(double p) 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.
Operator	getOperator() The Operator used to combine the input distributions.
java.lang.Double	sample() Returns the next sample from this 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, 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

ContDistAggregate

public ContDistAggregate(Model owner,
                         java.lang.String name,
                         java.util.List<NumericalDist<?>> dists,
                         Operator operator,
                         boolean showInReport,
                         boolean showInTrace)

Creates a stream of pseudo random numbers following a distribution that is specified by a list of other distributions and an operator to aggregate them.

Note that since it is possible to combine distributions of different return types, this distribution will always cast their results to double and return a double itself.

Parameters:

owner - Model : The distribution's owner

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

dists - List : The input distributions.

operator - Operator : The operator to be used to aggregate the distributions.

showInReport - boolean : Flag for producing reports

showInTrace - boolean : Flag for producing trace output

ContDistAggregate

public ContDistAggregate(Model owner,
                         java.lang.String name,
                         NumericalDist<?> dist1,
                         NumericalDist<?> dist2,
                         Operator operator,
                         boolean showInReport,
                         boolean showInTrace)

Creates a stream of pseudo random numbers following a distribution that is specified by two other distributions and an operator to aggregate them.

Note that since it is possible to combine distributions of different return types, this distribution will always cast their results to double and return a double itself.

Parameters:

owner - Model : The distribution's owner

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

dist1 - NumericalDist : The first input distribution.

dist2 - NumericalDist : The second input distribution.

operator - Operator : The operator to be used to combine the two distributions.

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

Overrides:

createDefaultReporter in class Distribution

Returns:

Reporter : The reporter for the ContDistAggregate distribution

See Also:

ContDistAggregateReporter

getDists

public java.util.List<NumericalDist<?>> getDists()

Returns the first input distribution.

Returns:

The first input distribution

getOperator

public Operator getOperator()

The Operator used to combine the input distributions.

Returns:

The Operator used to combine the two distributions.

sample

public java.lang.Double sample()

Returns the next sample from this distribution. The value depends upon the seed, the number of values taken from the stream by using this method before and the two input distributions as well as the operator specified for this distribution.

Evaluation is done from left to right, e.g. for three distributions, the results is (dist1.sample x d2.sample()) x d3.sample(), where x is the operation used.

Overrides:

sample in class NumericalDist<java.lang.Double>

Returns:

double : The next sample from this distribution.

getInverseOfCumulativeProbabilityFunction

public java.lang.Double getInverseOfCumulativeProbabilityFunction(double p)

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. Not supported, i.e. throwing an UnsupportedOperationException.

Specified by:

getInverseOfCumulativeProbabilityFunction in class NumericalDist<java.lang.Double>

Parameters:

p - double: A value between 0 and 1

Returns:

An UnsupportedOperationException exception