Package org.palladiosimulator.monitorrepository.statisticalcharacterization

Class GeometricMeanAggregator

java.lang.Object

org.palladiosimulator.monitorrepository.statisticalcharacterization.StatisticalCharacterizationAggregator

org.palladiosimulator.monitorrepository.statisticalcharacterization.GeometricMeanAggregator

public class GeometricMeanAggregator
extends StatisticalCharacterizationAggregator

StatisticalCharacterizationAggregator corresponding to the GeometricMean model class which computes the geometric mean of a sequence of measurements (discrete case) or a (positive) function with respect to an interval (continuous case):
In the discrete case this is simply GM=(x1 * x2 * ... * xn) ^ 1/n with n being the number of measurements.
Note that it is not defined if any of the measurements is negative or exactly 0. In such a case this implementation returns 0.

In the continuous case, this aggregator approximates the integral GM=e^(∫log(f(x))dx ⁄ (b-a)) where a and b are upper and lower interval bound and the integration is carried out from a to b, and the (positive) function f is interpolated from a given (finite) set of samples (i.e., measurements).

See Also:

https://en.wikipedia.org/wiki/ Mean_of_a_function

Constructor Summary

Constructors

Constructor	Description
GeometricMeanAggregator(org.palladiosimulator.metricspec.NumericalBaseMetricDescription expectedWindowMetric)

Method Summary

Modifier and Type	Method	Description
protected javax.measure.Measure<Double,javax.measure.quantity.Quantity>	calculateStatisticalCharacterizationContinuous(Iterable<org.palladiosimulator.measurementframework.MeasuringValue> windowData)	Method to be implemented by each subclass to calculate the statistical characterization of a sequence of measurements with a continuous scope of validity (i.e., to aggregate them). This method is invoked within StatisticalCharacterizationAggregator.aggregateData(Iterable, Amount, Amount, Optional).
protected javax.measure.Measure<Double,javax.measure.quantity.Quantity>	calculateStatisticalCharaterizationDiscrete(Iterable<org.palladiosimulator.measurementframework.MeasuringValue> windowData)	Method to be implemented by each subclass to calculate the statistical characterization of a sequence of measurements with a discrete scope of validity (i.e., to aggregate them). This method is invoked within StatisticalCharacterizationAggregator.aggregateData(Iterable, Amount, Amount, Optional).

Methods inherited from class org.palladiosimulator.monitorrepository.statisticalcharacterization.StatisticalCharacterizationAggregator

aggregateData, getDataDefaultUnit, getDataMetric, getIntervalLength, obtainCurrentMeasurementValidityLength, obtainDataFromMeasurement, obtainDataValueFromMeasurement

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GeometricMeanAggregator

public GeometricMeanAggregator(org.palladiosimulator.metricspec.NumericalBaseMetricDescription expectedWindowMetric)

Method Detail

calculateStatisticalCharaterizationDiscrete

protected javax.measure.Measure<Double,javax.measure.quantity.Quantity> calculateStatisticalCharaterizationDiscrete(Iterable<org.palladiosimulator.measurementframework.MeasuringValue> windowData)

Description copied from class: StatisticalCharacterizationAggregator

Method to be implemented by each subclass to calculate the statistical characterization of a sequence of measurements with a discrete scope of validity (i.e., to aggregate them).
This method is invoked within StatisticalCharacterizationAggregator.aggregateData(Iterable, Amount, Amount, Optional).

Specified by:

calculateStatisticalCharaterizationDiscrete in class StatisticalCharacterizationAggregator

Parameters:

windowData - The sequence of data/measurements to be aggregated, expressed as an Iterable of MeasuringValues.

Returns:

A Measure representing the result of the aggregation.

See Also:

StatisticalCharacterizationAggregator.getDataMetric(), BaseMetricDescription.getScopeOfValidity()

calculateStatisticalCharacterizationContinuous

protected javax.measure.Measure<Double,javax.measure.quantity.Quantity> calculateStatisticalCharacterizationContinuous(Iterable<org.palladiosimulator.measurementframework.MeasuringValue> windowData)

Description copied from class: StatisticalCharacterizationAggregator

Method to be implemented by each subclass to calculate the statistical characterization of a sequence of measurements with a continuous scope of validity (i.e., to aggregate them).
This method is invoked within StatisticalCharacterizationAggregator.aggregateData(Iterable, Amount, Amount, Optional).

Specified by:

calculateStatisticalCharacterizationContinuous in class StatisticalCharacterizationAggregator

Parameters:

windowData - The sequence of data/measurements to be aggregated, expressed as an Iterable of MeasuringValues.

Returns:

A Measure representing the result of the aggregation.

See Also:

StatisticalCharacterizationAggregator.getDataMetric(), BaseMetricDescription.getScopeOfValidity()