org.djutils.stats.summarizers.TallyStatistic Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of djutils-stats Show documentation

DJUTILS statistical and data storage utilities

There is a newer version: 2.2.2

package org.djutils.stats.summarizers;

/**
 * TallyStatistic makes the common methods of any type of Tally available (unweighted, weighted, timestamped, or event based).
 * 
 * Copyright (c) 2023-2024 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See
 * for project information  https://djutils.org. The DJUTILS project is
 * distributed under a three-clause BSD-style license, which can be found at
 *  https://djutils.org/docs/license.html.
 * 
 * @author Alexander Verbraeck
 */
public interface TallyStatistic extends Statistic
{
    /**
     * Returns the maximum value of any given observation, or NaN when no observations were registered.
     * @return double; the maximum value of any given observation
     */
    double getMax();

    /**
     * Returns the minimum value of any given observation, or NaN when no observations were registered.
     * @return double; the minimum value of any given observation
     */
    double getMin();

}