at.borkowski.scovillej.profile

Interface SeriesResult<T>

Type Parameters:

T - The type of number measured

All Known Subinterfaces:

SeriesProvider<T>

All Known Implementing Classes:

DoubleSeriesImpl, FloatSeriesImpl, IntegerSeriesImpl, LongSeriesImpl, NumberSeriesImpl, SeriesImpl, VoidSeriesImpl

public interface SeriesResult<T>

Represents the result of a series of measurements. This interface represents the reader-side view of the series, ie. the interface for reading values and aggregated numbers.

Method Summary

Modifier and Type	Method and Description
Map<Long,T>	getAll() Returns all measured values as a map from the tick to the value.
Double	getAverage() Returns an average (arithmetic mean) of all measured values.
Map<Long,Double>	getAveraged(long classWidth) Returns an averaged version of all values.
long	getCount() Returns the number of measured values.
Double	getDoubleMedian() Returns the median of all measured values.
T	getMax() Returns the maximum value of all measured values.
T	getMin() Returns the minimum value of all measured values.
T	getNativeMedian() Returns the median of all measured values.
T[]	getNativeMedians() Returns the median candidates of all measured values.
Double	getStandardDeviation() Returns the standard deviation of all measured values.
boolean	hasSingleMedian() Determines whether the series has one median (because it has an odd number of values, or because it is even and two median candidates are equal).

Method Detail

getAll

Map<Long,T> getAll()

Returns all measured values as a map from the tick to the value.

Returns:

all measured values

getAveraged

Map<Long,Double> getAveraged(long classWidth)

Returns an averaged version of all values. The measured values are averaged into classes with a width of classWidth. The returned map contains all averaged results as a map from the tick (the beginning, "left border" of the class) to the average value.

Parameters:

classWidth - the width in ticks for the classes

Returns:

the resulting map

getAverage

Double getAverage()

Returns an average (arithmetic mean) of all measured values.

Returns:

the average

getDoubleMedian

Double getDoubleMedian()

Returns the median of all measured values. This method always returns a Double, even if the measured values are integer and one median is present. For a more exact version, see getNativeMedian(). If there are two median values (because the number of measurements is even), the arithmetic mean of the two values is returned.

Returns:

the median

getStandardDeviation

Double getStandardDeviation()

Returns the standard deviation of all measured values.

Returns:

the standard deviation

getMin

T getMin()

Returns the minimum value of all measured values.

Returns:

the minimum value

getMax

T getMax()

Returns the maximum value of all measured values.

Returns:

the maximum value

getNativeMedians

T[] getNativeMedians()

Returns the median candidates of all measured values.

Returns:

the native median candidates

getNativeMedian

T getNativeMedian()

Returns the median of all measured values. In contrast to getDoubleMedian(), this method returns an exact median if there is one median. If there are two median values, the returned value depends on the implemented measurement series, but will be performed in a mean-like way (possible rounded towards some integer value).

Returns:

the median in native type

hasSingleMedian

boolean hasSingleMedian()

Determines whether the series has one median (because it has an odd number of values, or because it is even and two median candidates are equal).

Returns:

whether the series has one median

getCount

long getCount()

Returns the number of measured values.

Returns:

the number of measured values