Class Statistics.Delta

  • All Implemented Interfaces:
    Serializable, Cloneable, Cloneable
    Enclosing class:
    Statistics

    public static class Statistics.Delta
    extends Statistics
    Holds some statistics about a series of sample values and the difference between them. Given a series of sample values s0, s1, s2, s3..., this class computes statistics in the same way than Statistics and additionnaly computes statistics for s1-s0, s2-s1, s3-s2..., which are stored in a delta statistics object.
    Author:
    Martin Desruisseaux (IRD)
    See Also:
    Serialized Form
    • Constructor Detail

      • Delta

        public Delta()
        Constructs an initially empty set of statistics. All statistical values are initialized to Double.NaN.
      • Delta

        public Delta​(Statistics delta)
        Constructs an initially empty set of statistics using the specified object for delta statistics. This method allows chaining different kind of statistics objects. For example, one could write:
         new Statistics.Delta(new Statistics.Delta());
         
        Which would compute statistics of sample values, statistics of difference between consecutive sample values, and statistics of difference of difference between consecutive sample values. Other kinds of Statistics object could be chained as well.
    • Method Detail

      • getDeltaStatistics

        public Statistics getDeltaStatistics()
        Returns the statistics about difference between consecutives values. Given a series of sample values s0, s1, s2, s3..., this is statistics for s1-s0, s2-s1, s3-s2...,
      • reset

        public void reset()
        Resets the statistics to their initial NaN values. This method reset this object state as if it was just created.
        Overrides:
        reset in class Statistics
      • add

        public void add​(double sample)
        Updates statistics for the specified sample. The delta statistics are updated with sample - samplelast value, where samplelast is the last value given to the previous call of an add(...) method.
        Overrides:
        add in class Statistics
        Parameters:
        sample - The sample value. NaN values are ignored.
        See Also:
        Statistics.add(long), Statistics.add(Statistics)
      • add

        public void add​(long sample)
        Updates statistics for the specified sample. The delta statistics are updated with sample - samplelast value, where samplelast is the last value given to the previous call of an add(...) method.
        Overrides:
        add in class Statistics
        Parameters:
        sample - The sample value.
        See Also:
        Statistics.add(double), Statistics.add(Statistics)
      • add

        public void add​(Statistics stats)
                 throws ClassCastException
        Update statistics with all samples from the specified stats. Invoking this method is equivalent (except for rounding errors) to invoking add for all samples that were added to stats. The stats argument must be an instance of Statistics.Delta.
        Overrides:
        add in class Statistics
        Parameters:
        stats - The statistics to be added to this, or null if none.
        Throws:
        ClassCastException - If stats is not an instance of Statistics.Delta.
      • equals

        public boolean equals​(Object obj)
        Tests this statistics with the specified object for equality.
        Overrides:
        equals in class Statistics
      • hashCode

        public int hashCode()
        Returns a hash code value for this statistics.
        Overrides:
        hashCode in class Statistics