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-2020 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>.
14 * <br>
15 * @author <a href="https://www.tudelft.nl/averbraeck" target="_blank"> Alexander Verbraeck</a>
16 * @author <a href="https://www.tudelft.nl/staff/p.knoppers/">Peter Knoppers</a>
17 */
18 public interface BasicTallyInterface extends Serializable
19 {
20 /**
21 * initializes the Tally. This methods sets the max, min, n, sum and variance values to their initial values.
22 */
23 void initialize();
24
25 /**
26 * returns the description of this tally.
27 * @return Sting description
28 */
29 String getDescription();
30
31 /**
32 * Returns the number of observations.
33 * @return long n
34 */
35 long getN();
36
37 /**
38 * Returns the max.
39 * @return double
40 */
41 double getMax();
42
43 /**
44 * Returns the min.
45 * @return double
46 */
47 double getMin();
48
49 }