desmoj.core.statistic

Class ConfidenceCalculator

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.statistic.StatisticObject

desmoj.core.statistic.StatisticObjectSupportingTimeSpans

desmoj.core.statistic.ValueStatistics

desmoj.core.statistic.Tally

desmoj.core.statistic.ConfidenceCalculator

All Implemented Interfaces:

java.util.Observer

public class ConfidenceCalculator
extends Tally

The ConfidenceCalculator class has the same functionality as the Tally class. Additionally, it calculates a confidence interval for the mean of the samples passed to the ConfidenceCalculator. Note that the confidence interval computation assumes that the samples are (approximately) identically and independently distributed. Observe that the confidence interval estimations of this class are meaningless should this assumption not hold!

Version:

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

Author:

Soenke Claassen, based on DESMO-C from Thomas Schniewind, 1998 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:

Tally

Field Summary

Fields inherited from class desmoj.core.statistic.StatisticObject

UNDEFINED

Constructor Summary

Constructors

Constructor and Description
ConfidenceCalculator(Model ownerModel, java.lang.String name, boolean showInReport, boolean showInTrace) Constructor for a ConfidenceCalculator object that has no connection to a ValueSupplier.
ConfidenceCalculator(Model ownerModel, java.lang.String name, ValueSupplier valSup, boolean showInReport, boolean showInTrace) Constructor for a ConfidenceCalculator object that is connected to a ValueSupplier.

Method Summary

Modifier and Type	Method and Description
Reporter	createDefaultReporter() Returns a Reporter to produce a report about this ConfidenceCalculator.
double	getConfidenceIntervalOfMeanLowerBound() Calculates the lower bound of the confidence interval of the mean.
double	getConfidenceIntervalOfMeanUpperBound() Calculates the upper bound of the confidence interval of the mean.
double	getConfidenceLevel() Returns the confidence level.
void	setConfidenceLevel(double level) Sets the confidence level; default value is 0.95.

Methods inherited from class desmoj.core.statistic.Tally

getMean, getStdDev, reset, update, update, update

Methods inherited from class desmoj.core.statistic.ValueStatistics

getLastValue, getMaximum, getMinimum, update

Methods inherited from class desmoj.core.statistic.StatisticObjectSupportingTimeSpans

getShowTimeSpansInReport, getUnit, setShowTimeSpansInReport

Methods inherited from class desmoj.core.statistic.StatisticObject

getUnitText, round, setUnit

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

ConfidenceCalculator

public ConfidenceCalculator(Model ownerModel,
                            java.lang.String name,
                            ValueSupplier valSup,
                            boolean showInReport,
                            boolean showInTrace)

Constructor for a ConfidenceCalculator object that is connected to a ValueSupplier. The confidence level is set to 0.95.

Parameters:

ownerModel - Model : The model this ConfidenceCalculator is associated to

name - java.lang.String : The name of this ConfidenceCalculator object

valSup - ValueSupplier : The ValueSupplier providing the value for this ConfidenceCalculator. The given ValueSupplier will be observed by this ConfidenceCalculator object.

showInReport - boolean : Flag for showing the report about this ConfidenceCalculator.

showInTrace - boolean : Flag for showing the trace output of this ConfidenceCalculator.

ConfidenceCalculator

public ConfidenceCalculator(Model ownerModel,
                            java.lang.String name,
                            boolean showInReport,
                            boolean showInTrace)

Constructor for a ConfidenceCalculator object that has no connection to a ValueSupplier. The confidence level is set to 0.95.

Parameters:

ownerModel - Model : The model this ConfidenceCalculator is associated to

name - java.lang.String : The name of this ConfidenceCalculator object

showInReport - boolean : Flag for showing the report about this ConfidenceCalculator.

showInTrace - boolean : Flag for showing the trace output of this ConfidenceCalculator.

Method Detail

createDefaultReporter

public Reporter createDefaultReporter()

Returns a Reporter to produce a report about this ConfidenceCalculator.

Overrides:

createDefaultReporter in class Tally

Returns:

desmoj.report.Reporter : The Reporter for this ConfidenceCalculator.

setConfidenceLevel

public void setConfidenceLevel(double level)

Sets the confidence level; default value is 0.95.

Note: The confidence interval computation assumes that the input values are (approximately) identically and independently distributed.

Parameters:

level - double : the confidence level

getConfidenceLevel

public double getConfidenceLevel()

Returns the confidence level.

Returns:

double : the confidence level

getConfidenceIntervalOfMeanUpperBound

public double getConfidenceIntervalOfMeanUpperBound()

Calculates the upper bound of the confidence interval of the mean.

Returns:

double : The upper bound of the confidence interval of the mean

getConfidenceIntervalOfMeanLowerBound

public double getConfidenceIntervalOfMeanLowerBound()

Calculates the lower bound of the confidence interval of the mean.

Returns:

double : The lower bound of the confidence interval of the mean