Package org.djutils.stats.summarizers

Interface BasicTallyInterface

All Superinterfaces:
Serializable
All Known Subinterfaces:
TallyInterface, TimestampTallyInterface, WeightedTallyInterface
All Known Implementing Classes:
EventBasedTally, EventBasedTimestampWeightedTally, EventBasedWeightedTally, Tally, TimestampWeightedTally, WeightedTally
public interface BasicTallyInterface
extends Serializable
The Tally interface defines the methods to be implemented by a tally object, which ingests a series of values and provides mean, standard deviation, etc. of the ingested values. This basic interface definews the methods that all tallies share.

Copyright (c) 2002-2020 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

    Modifier and Type Method Description
    String getDescription()
    returns the description of this tally.
    double getMax()
    Returns the max.
    double getMin()
    Returns the min.
    long getN()
    Returns the number of observations.
    void initialize()
    initializes the Tally.

  • Method Details

    • initialize

      void initialize()
      initializes the Tally. This methods sets the max, min, n, sum and variance values to their initial values.

    • getDescription

      String getDescription()
      returns the description of this tally.
      Returns:
      Sting description

    • getN

      long getN()
      Returns the number of observations.
      Returns:
      long n

    • getMax

      double getMax()
      Returns the max.
      Returns:
      double

    • getMin

      double getMin()
      Returns the min.
      Returns:
      double