Back to Aurora Vision Library website

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

GetMedianElement_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: avl
Module: FoundationLite

Gets array element corresponding to median value from the inValues array; returns NIL if the arrays are empty.

Syntax

void avl::GetMedianElement_OrNil
(
	const atl::Array<Type>& inArray,
	const atl::Array<float>& inValues,
	typename atl::ToConditionalType<Type>::Type& outElement,
	atl::Conditional<float>& outValue,
	atl::Conditional<int>& outIndex
)

Parameters

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

Errors

List of possible exceptions:

Error type Description
DomainError Inconsistent array sizes in GetMedianElement_OrNil.