desmoj.core.dist

Class SeriesNumerical<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.Series<N>

desmoj.core.dist.SeriesNumerical<N>

public class SeriesNumerical<N extends java.lang.Number>
extends Series<N>

A series is a special distribution returning preset, user-defined entries from a list. This subclass of Series serves to sample numbers from a custom numerical data type. Series may be used to simulate certain non-random scenarios within the simulation or to include external sources of (preudo) random distributions

The internal list can be set to be traversed backwards and/or to repeat once its end has been reached.

Version:

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

Author:

Broder Fredrich 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
SeriesNumerical(Model owner, java.lang.String name, boolean showInReport, boolean showInTrace) Creates a new SeriesNumerical.

Method Summary

Modifier and Type	Method and Description
double	getMean() Returns the mean value of all samples that have been returned via the sample() method.
double	getStdDev() Returns the standard deviation of all the values sampled so far.
N	sample() Returns the next sample from the value list.
TimeSpan	sampleTimeSpan() Convenience method to sample a period of random length by creating a TimeSpan whose length is determined by sampling this series (time unit is the experiment's reference units), thus replacing the pattern new TimeSpan(series.sample()).
TimeSpan	sampleTimeSpan(java.util.concurrent.TimeUnit unit) Convenience method to sample a period of random length by creating a TimeSpan whose length is determined by sampling this series (time unit given explicitly as parameter), thus replacing the pattern new TimeSpan(series.sample(), unit).

Methods inherited from class desmoj.core.dist.Series

add, addAll, clearList, createDefaultReporter, getNumberOfAvailableElements, isforward, remove, sampleObject, set, setRepeating, setReverse

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

SeriesNumerical

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

Creates a new SeriesNumerical. Default behaviour when returning samples is - starting at 1st element - reading forward - non-repeating

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

sample

public N sample()

Returns the next sample from the value list.

Overrides:

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

Returns:

N : The sample to be returned.

sampleTimeSpan

public TimeSpan sampleTimeSpan()

Convenience method to sample a period of random length by creating a TimeSpan whose length is determined by sampling this series (time unit is the experiment's reference units), thus replacing the pattern new TimeSpan(series.sample()).

Returns:

TimeSpan : The TimeSpan sampled from this series

sampleTimeSpan

public TimeSpan sampleTimeSpan(java.util.concurrent.TimeUnit unit)

Convenience method to sample a period of random length by creating a TimeSpan whose length is determined by sampling this series (time unit given explicitly as parameter), thus replacing the pattern new TimeSpan(series.sample(), unit).

Parameters:

unit - TimeUnit: the TimeUnit to assign to the sampled value

Returns:

TimeSpan : The TimeSpan sampled from this series

getMean

public double getMean()

Returns the mean value of all samples that have been returned via the sample() method.

Returns:

double : The mean value of all returned samples

getStdDev

public double getStdDev()

Returns the standard deviation of all the values sampled so far.

Returns:

double : The standard deviation value of all returned samples