Back to FabImage Library website

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

GetSortedElements


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 elements corresponding to 8 smallest/biggest values from the array of values.

Syntax

void fil::GetSortedElements
(
	const ftl::Array<Type>& inArray,
	const ftl::Array<float>& inValues,
	fil::SortingOrder::Type inSortingOrder,
	ftl::Conditional<float>& outValue0,
	ftl::Conditional<float>& outValue1,
	ftl::Conditional<float>& outValue2,
	ftl::Conditional<float>& outValue3,
	ftl::Conditional<float>& outValue4,
	ftl::Conditional<float>& outValue5,
	ftl::Conditional<float>& outValue6,
	ftl::Conditional<float>& outValue7,
	typename ftl::ToConditionalType<Type>::Type& outElement0,
	typename ftl::ToConditionalType<Type>::Type& outElement1,
	typename ftl::ToConditionalType<Type>::Type& outElement2,
	typename ftl::ToConditionalType<Type>::Type& outElement3,
	typename ftl::ToConditionalType<Type>::Type& outElement4,
	typename ftl::ToConditionalType<Type>::Type& outElement5,
	typename ftl::ToConditionalType<Type>::Type& outElement6,
	typename ftl::ToConditionalType<Type>::Type& outElement7
)

Parameters

Name Type Default Description
Input value
 inArray const Array<Type>& Input array
Input value
 inValues const Array<float>& Values defining the order
Input value
 inSortingOrder SortingOrder::Type
Output value
 outValue0 Conditional<float>&
Output value
 outValue1 Conditional<float>&
Output value
 outValue2 Conditional<float>&
Output value
 outValue3 Conditional<float>&
Output value
 outValue4 Conditional<float>&
Output value
 outValue5 Conditional<float>&
Output value
 outValue6 Conditional<float>&
Output value
 outValue7 Conditional<float>&
Output value
 outElement0 typename ToConditionalType<Type>::Type&
Output value
 outElement1 typename ToConditionalType<Type>::Type&
Output value
 outElement2 typename ToConditionalType<Type>::Type&
Output value
 outElement3 typename ToConditionalType<Type>::Type&
Output value
 outElement4 typename ToConditionalType<Type>::Type&
Output value
 outElement5 typename ToConditionalType<Type>::Type&
Output value
 outElement6 typename ToConditionalType<Type>::Type&
Output value
 outElement7 typename ToConditionalType<Type>::Type&

Errors

List of possible exceptions:

Error type Description
DomainError Inconsistent array sizes in GetSortedElements.

See Also

  • SortArray – Changes the order of the input array elements according to an ascending/descending sequence of the value array.
  • GetMaximumElement – Returns an array element that corresponds to the biggest value in the array of values.
  • GetMinimumElement – Returns an array element that corresponds to the smallest value in the array of values.