You are here: Start » Function Reference » All Functions » Real » MinimumReal_OfArray_OrNil

MinimumReal_OfArray_OrNil

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:	fil
Module:	FoundationLite

Returns the smallest value in an array of real numbers; returns NIL if the array is empty.

Syntax

void fil::MinimumReal_OfArray_OrNil
(
	const ftl::Array<float>& inArray,
	ftl::Conditional<float>& outMinimum,
	ftl::Optional<ftl::Conditional<int>&> outIndex = ftl::NIL
)

Parameters

Name	Type	Default	Description
inArray	const Array<float>&		Input array of Real values
outMinimum	Conditional<float>&		Conditional output Real value of lowest value within inArray; returns Nil if array is empty
outIndex	Optional<Conditional<int>&>	NIL	Conditional output Integer index value of lowest value within inArray; returns Nil if array is empty

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outIndex.