org.diirt.util.stats.Statistics Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of diirt-util Show documentation

Basic Java utility classes to be shared across projects until suitable replacements are available in the JDK.

The newest version!

/**
 * Copyright (C) 2010-18 diirt developers. See COPYRIGHT.TXT
 * All rights reserved. Use is subject to license terms. See LICENSE.TXT
 */
package org.diirt.util.stats;

/**
 * The statistics of a given set of numbers.
 * 
 * For the purpose of statistics calculation, NaNs should be skipped. That is,
 * they should not appear as minimum, maximum, average or stdDev, and shouldn't
 * even be included in the count. The number of elements (including NaNs)
 * will be available from the number set used to create the statistics. This
 * can be useful to determine whether the set actually contained any valid
 * values and therefore if there is anything to do.
 * 
 * The appropriate Statistics instance for
 * an unknown set, or for a set of NaN values, is null.
 *
 * @author carcassi
 */
public abstract class Statistics  {

    /**
     * The range of the values.
     *
     * @return the range
     */
    public abstract Range getRange();

    /**
     * The number of values (excluding NaN) included in the set.
     *
     * @return the number of values
     */
    public abstract int getCount();

    /**
     * The average value.
     *
     * @return the average value
     */
    public abstract double getAverage();

    /**
     * The standard deviation.
     *
     * @return the standard deviation
     */
    public abstract double getStdDev();
}