Back to Adaptive Vision Library website
You are here: Start » Function Reference » All Functions » Loop Utils » LoopMaximum
LoopMaximum
This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.
Header: | STD.h |
---|---|
Namespace: | avl |
Module: | FoundationLite |
Returns the object for which the associated value was the highest among all iterations.
Syntax
void avl::LoopMaximum ( const T& inObject, float inValue, bool inReset, T& outMaximumObject, float& outMaximumValue, int& outMaximumIndex )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
inObject | const T& | Object that may be chosen | ||
inValue | float | Value associated with the input object | ||
inReset | bool | False | Reset accumulator state | |
outMaximumObject | T& | The object whose associated value was the highest | ||
outMaximumValue | float& | Maximum value that appeared in the loop | ||
outMaximumIndex | int& | Index of iteration when the maximum object appeared |
Hints
- It is recommended not to use this filter in conditional mode. Use conditional type for instantiation instead.