Back to Aurora Vision Library website

You are here: Start » Function Reference » All Functions » Loop Utils » LoopMinimum

LoopMinimum


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 lowest among all iterations.

Syntax

void avl::LoopMinimum
(
	const T& inObject,
	float inValue,
	bool inReset,
	T& outMinimumObject,
	float& outMinimumValue,
	int& outMinimumIndex
)

Parameters

Name Type Default Description
Input value inObject const T& Object that may be chosen
Input value inValue float Value associated with the input object
Input value inReset bool False Reset accumulator state
Output value outMinimumObject T& The object whose associated value was the lowest
Output value outMinimumValue float& Minimum value that appeared in the loop
Output value outMinimumIndex int& Index of iteration when the minimum object appeared

Hints

  • It is recommended not to use this filter in conditional mode. Use conditional type for instantiation instead.