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

MinimumDouble_OfArray

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

Returns the smallest value in an array of double numbers.

Syntax

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

Parameters

	Name	Type	Default	Description
	inInitialValue	const Optional<double>&	NIL	Optional initial input Double value
	inArray	const Array<double>&		Input array of Double values
	outMinimum	double&		Output Double value of lowest value within inArray; returns inInitialValue if it is lower than any value within array or if array is empty
	outIndex	Optional<Conditional<int>&>	NIL	Conditional output Integer index value of lowest value within inArray; returns Nil if inInitialValue is lower than any value within array or if array is empty

Optional Outputs

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

Read more about Optional Outputs.

Errors