Package org.djutils.stats.summarizers
Interface WeightedTallyInterface
-
- All Superinterfaces:
BasicTallyInterface
,Serializable
- All Known Subinterfaces:
TimestampTallyInterface
- All Known Implementing Classes:
EventBasedTimestampWeightedTally
,EventBasedWeightedTally
,TimestampWeightedTally
,WeightedTally
public interface WeightedTallyInterface extends BasicTallyInterface
The WeightedTally interface defines the methods that a time-weighted tally should implement.Copyright (c) 2002-2021 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://simulation.tudelft.nl. The DSOL project is distributed under a three-clause BSD-style license, which can be found at https://simulation.tudelft.nl/dsol/3.0/license.html.
- Author:
- Alexander Verbraeck, Peter Knoppers
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default double
getWeightedPopulationMean()
Retrieve the current weighted mean of all observations since the initialization.double
getWeightedPopulationStDev()
Retrieve the current weighted standard deviation of the observations.double
getWeightedPopulationVariance()
Retrieve the current weighted variance of the observations.double
getWeightedSampleMean()
Retrieve the current weighted sample mean of all observations since the initialization.double
getWeightedSampleStDev()
Retrieve the current weighted sample standard deviation of the observations.double
getWeightedSampleVariance()
Retrieve the current weighted sample variance of the observations.double
getWeightedSum()
Retrieve the current weighted sum of the values of the observations.-
Methods inherited from interface org.djutils.stats.summarizers.BasicTallyInterface
getDescription, getMax, getMin, getN, initialize
-
-
-
-
Method Detail
-
getWeightedSampleMean
double getWeightedSampleMean()
Retrieve the current weighted sample mean of all observations since the initialization.- Returns:
- double; the current weighted sample mean
-
getWeightedPopulationMean
default double getWeightedPopulationMean()
Retrieve the current weighted mean of all observations since the initialization.- Returns:
- double; the current weighted mean
-
getWeightedSampleStDev
double getWeightedSampleStDev()
Retrieve the current weighted sample standard deviation of the observations.- Returns:
- double; the current weighted sample standard deviation
-
getWeightedPopulationStDev
double getWeightedPopulationStDev()
Retrieve the current weighted standard deviation of the observations.- Returns:
- double; the current weighted standard deviation
-
getWeightedSampleVariance
double getWeightedSampleVariance()
Retrieve the current weighted sample variance of the observations.- Returns:
- double; the current weighted sample variance of the observations
-
getWeightedPopulationVariance
double getWeightedPopulationVariance()
Retrieve the current weighted variance of the observations.- Returns:
- double; the current weighted variance of the observations
-
getWeightedSum
double getWeightedSum()
Retrieve the current weighted sum of the values of the observations.- Returns:
- double; the current weighted sum of the values of the observations
-
-