Reduce

public abstract class Reduce
Known Direct Subclasses
Known Indirect Subclasses

Encapsulates metrics that perform a reduce operation on the metric values.

Constants

String COUNT
String TOTAL

Public Methods

Variable<T>
getCount()
Gets the count variable
Class<T>
getResultType()
Gets the type for the variables
Variable<T>
getTotal()
Gets the total variable
Op
resetStates()
Resets any state variables to their initial values
Operand<T>
result()
Gets the current result of the metric
List<Op>
updateStateList(Operand<? extends TNumber> values, Operand<? extends TNumber> sampleWeights)
Updates the metric variables based on the inputs.

Inherited Methods

Constants

public static final String COUNT

Constant Value: "count"

public static final String TOTAL

Constant Value: "total"

Public Methods

public Variable<T> getCount ()

Gets the count variable

Returns
  • the count variable

public Class<T> getResultType ()

Gets the type for the variables

Returns
  • the type for the variables

public Variable<T> getTotal ()

Gets the total variable

Returns
  • the total variable

public Op resetStates ()

Resets any state variables to their initial values

Returns
  • the control operation for doing the reset

public Operand<T> result ()

Gets the current result of the metric

Returns
  • the result, possibly with control dependencies

public List<Op> updateStateList (Operand<? extends TNumber> values, Operand<? extends TNumber> sampleWeights)

Updates the metric variables based on the inputs. At least one input arg required for values, an optional additional input for the sampleWeights

Parameters
values the inputs to be passed to update state, this may not be null
sampleWeights sample weights to be applied to values, may be null.
Returns
  • the result with a control dependency on update state Operands
Throws
IllegalArgumentException if values is null