You are here: Start » Function Reference » All Functions » Array Statistics » GetMaximumElement_OrNil

GetMaximumElement_OrNil

This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Returns an array element that corresponds to the biggest value in the array of values; returns NIL if the arrays are empty.

Applications: Choosing one object from an array on the basis of some feature, e.g. the blob having the highest area.

Syntax

void fil::GetMaximumElement_OrNil
(
	const ftl::Array<Type>& inArray,
	const ftl::Array<float>& inValues,
	typename ftl::ToConditionalType<Type>::Type& outElement,
	ftl::Conditional<float>& outValue,
	ftl::Conditional<int>& outIndex
)

Parameters

	Name	Type	Default	Description
	inArray	const Array<Type>&		Elements from which element corresponding to biggest value will be chosen
	inValues	const Array<float>&		Values defining the order
	outElement	typename ToConditionalType<Type>::Type&		Element from the array
	outValue	Conditional<float>&		Biggest value
	outIndex	Conditional<int>&		Index of the biggest value

Errors