com.fluxtion.ext.declarative.api.numeric

Interface NumericFunctionStateful

All Superinterfaces:

NumericFunctionStateless

All Known Implementing Classes:

AggregateFunctions.AggregateAverage

public interface NumericFunctionStateful
extends NumericFunctionStateless

A Marker interface for an aggregating numeric functions. If a class uses this interface then it must implement only one public method. The first argument of the calculation method will be the previously returned value. The types of the return and the first argument should match.

Author:

greg higgins

Method Summary

Modifier and Type	Method and Description
default double	reset() A stateful function should be reset to initial state on receiving this call.

Method Detail

reset

default double reset()

A stateful function should be reset to initial state on receiving this call. For example an average calculation would zero all counts and sums.

Returns:

the reset value for this calculation