1 package org.djutils.stats.summarizers;
2
3 import java.io.Serializable;
4
5 /**
6 * The Tally interface defines the methods to be implemented by a tally object, which ingests a series of values and provides
7 * mean, standard deviation, etc. of the ingested values. This basic interface definews the methods that all tallies share.
8 * <p>
9 * Copyright (c) 2002-2022 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See
10 * for project information <a href="https://simulation.tudelft.nl/" target="_blank"> https://simulation.tudelft.nl</a>. The DSOL
11 * project is distributed under a three-clause BSD-style license, which can be found at
12 * <a href="https://simulation.tudelft.nl/dsol/3.0/license.html" target="_blank">
13 * https://simulation.tudelft.nl/dsol/3.0/license.html</a>. <br>
14 * @author <a href="https://www.tudelft.nl/averbraeck" target="_blank"> Alexander Verbraeck</a>
15 * @author <a href="https://www.tudelft.nl/staff/p.knoppers/">Peter Knoppers</a>
16 */
17 public interface BasicTallyInterface extends Serializable
18 {
19 /**
20 * initializes the Tally. This methods sets the max, min, n, sum and variance values to their initial values.
21 */
22 void initialize();
23
24 /**
25 * returns the description of this tally.
26 * @return Sting description
27 */
28 String getDescription();
29
30 /**
31 * Returns the number of observations.
32 * @return long n
33 */
34 long getN();
35
36 /**
37 * Returns the max.
38 * @return double
39 */
40 double getMax();
41
42 /**
43 * Returns the min.
44 * @return double
45 */
46 double getMin();
47
48 }