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.

Returns the object for which the associated value was the lowest among all iterations.

Syntax

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

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
	outMinimumObject	T&		The object whose associated value was the lowest
	outMinimumValue	float&		Minimum value that appeared in the loop
	outMinimumIndex	int&		Index of iteration when the minimum object appeared

Hints