org.djutils.stats.summarizers.Statistic Maven / Gradle / Ivy
Show all versions of djutils-stats Show documentation
package org.djutils.stats.summarizers;
import java.io.Serializable;
/**
* The Statistic interface defines the methods to implement for each of the statistics classes.
*
* Copyright (c) 2023-2024 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
*/
public interface Statistic extends Serializable
{
/**
* Initialize the statistic.
*/
void initialize();
/**
* Returns the description of the statistic.
* @return String; the description of the statistic
*/
String getDescription();
/**
* Return the current number of observations.
* @return long; the number of observations
*/
long getN();
/**
* Return a string representing a line with important statistics values for this statistic, for a textual table with a
* monospaced font that can contain multiple statistics.
* @return String; line with most important values of the statistic
*/
String reportLine();
/**
* Return a formatted string with 2 digits precision for a floating point value that fits the number of characters. The
* formatter will fall back to scientific notation when the value does not fit with floating point notation.
* @param value double; the value to format
* @param numberCharacters int; the number of characters for the result
* @return String; a string representation with the given number of characters
*/
default String formatFixed(final double value, final int numberCharacters)
{
if (Double.isNaN(value) || Double.isInfinite(value) || value == 0.0 || Math.abs(value) >= 0.01)
{
String formatted = String.format("%" + numberCharacters + ".3f", value);
if (formatted.length() == numberCharacters)
{
return formatted;
}
}
return String.format("%" + numberCharacters + ".3e", value);
}
}