1 package org.djutils.stats.summarizers;
2
3 /**
4 * The WeightedTally interface defines the methods that a time-weighted tally should implement.
5 * <p>
6 * Copyright (c) 2002-2021 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See
7 * for project information <a href="https://simulation.tudelft.nl/" target="_blank"> https://simulation.tudelft.nl</a>. The DSOL
8 * project is distributed under a three-clause BSD-style license, which can be found at
9 * <a href="https://simulation.tudelft.nl/dsol/3.0/license.html" target="_blank">
10 * https://simulation.tudelft.nl/dsol/3.0/license.html</a>. <br>
11 * @author <a href="https://www.tudelft.nl/averbraeck" target="_blank"> Alexander Verbraeck</a>
12 * @author <a href="https://www.tudelft.nl/staff/p.knoppers/">Peter Knoppers</a>
13 */
14 public interface WeightedTallyInterface extends BasicTallyInterface
15 {
16 /**
17 * Retrieve the current weighted sample mean of all observations since the initialization.
18 * @return double; the current weighted sample mean
19 */
20 double getWeightedSampleMean();
21
22 /**
23 * Retrieve the current weighted mean of all observations since the initialization.
24 * @return double; the current weighted mean
25 */
26 default double getWeightedPopulationMean()
27 {
28 return getWeightedSampleMean();
29 }
30
31 /**
32 * Retrieve the current weighted sample standard deviation of the observations.
33 * @return double; the current weighted sample standard deviation
34 */
35 double getWeightedSampleStDev();
36
37 /**
38 * Retrieve the current weighted standard deviation of the observations.
39 * @return double; the current weighted standard deviation
40 */
41 double getWeightedPopulationStDev();
42
43 /**
44 * Retrieve the current weighted sample variance of the observations.
45 * @return double; the current weighted sample variance of the observations
46 */
47 double getWeightedSampleVariance();
48
49 /**
50 * Retrieve the current weighted variance of the observations.
51 * @return double; the current weighted variance of the observations
52 */
53 double getWeightedPopulationVariance();
54
55 /**
56 * Retrieve the current weighted sum of the values of the observations.
57 * @return double; the current weighted sum of the values of the observations
58 */
59 double getWeightedSum();
60
61 }