desmoj.core.dist

Class EntityDistEmpirical<E extends Entity>

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.dist.Distribution

desmoj.core.dist.EntityDist<E>

desmoj.core.dist.EntityDistEmpirical<E>

Type Parameters:

E - the element type

public class EntityDistEmpirical<E extends Entity>
extends EntityDist<E>

Empirically distributed stream of entities.

Version:

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

Author:

Tim Lechler, Philip Joschko, Johannes Göbel 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
EntityDistEmpirical(Model owner, java.lang.String name, boolean showInReport, boolean showInTrace) Creates a stream of entities, where an individual probability can be assigned to each entity.

Method Summary

Modifier and Type	Method and Description
boolean	add(E e, double probability) Adds an entity (type E) to the range of this distribution, unless it is already present.
void	changeProbability(E e, double newProbability) Adjusts the relative probability of an entity (type E from the range of this distribution being sampled.
boolean	contains(E e) Checks whether an entity is present (i.e. potentially sampled) by this distribution
Reporter	createDefaultReporter() Creates the default reporter for the EntityDistEmpirical distribution.
boolean	remove(E e) Removes an entity (type E) from the range of this distribution, if it is included.
E	sample() Returns the next empirically distributed entity sample.
void	setNonNegative(boolean newValue) Overrides the same method of desmoj.dist.Distribution.

Methods inherited from class desmoj.core.dist.EntityDist

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

EntityDistEmpirical

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

Creates a stream of entities, where an individual probability can be assigned to each entity.

Parameters:

owner - Model : The distribution's owner

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

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

Overrides:

createDefaultReporter in class Distribution

Returns:

Reporter : The reporter for the EntityDistEmpirical distribution

See Also:

EntityDistEmpiricalReporter

add

public boolean add(E e,
                   double probability)

Adds an entity (type E) to the range of this distribution, unless it is already present.

Parameters:

e - E : The entity to be added to the range of this distribution.

probability - double : The relative probability of this distribution sampling Entity e.

Returns:

boolean : True, if the entity has been added to the range of this distribution (false, if it was already present).

changeProbability

public void changeProbability(E e,
                              double newProbability)

Adjusts the relative probability of an entity (type E from the range of this distribution being sampled.

Parameters:

e - E : The entity whose relative probability is adjusted.

newProbability - double : The new relative probability of this distribution sampling Entity e.

contains

public boolean contains(E e)

Checks whether an entity is present (i.e. potentially sampled) by this distribution

Parameters:

e - E : The entity to be checked.

Returns:

boolean : True, if the entity is included in the range of this distribution and false otherwise.

remove

public boolean remove(E e)

Removes an entity (type E) from the range of this distribution, if it is included.

Parameters:

e - E : The entity to be removed from the range of this distribution.

Returns:

boolean : True, if the entity has been removed from the range of this distribution (false, if it was not present).

sample

public E sample()

Returns the next empirically distributed entity sample.

Specified by:

sample in class EntityDist<E extends Entity>

Returns:

E : The next empirically distributed entity sample

setNonNegative

public void setNonNegative(boolean newValue)

Overrides the same method of desmoj.dist.Distribution. A warning that it makes no sense to set a EntityDistEmpirical to be (not) negative is printed since the distribution samples are not numerical.

Overrides:

setNonNegative in class Distribution

Parameters:

newValue - boolean : No effect. A warning is issued.