Back to Aurora Vision Library website

You are here: Start » Function Reference » All Functions » Conditional Processing » GroupByCase

GroupByCase


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

Groups the elements of the input array into output arrays, depending on the associated array of case indices.

Syntax

void avl::GroupByCase
(
	const atl::Array<Type>& inArray,
	const atl::Array<int>& inCaseIndices,
	atl::Array<atl::Array<Type> >& outGroupedElements,
	atl::Array<atl::Array<int> >& outGroupedIndices
)

Parameters

Name Type Default Description
Input value inArray const Array<Type>& Elements to be grouped
Input value inCaseIndices const Array<int>& Reference values corresponding to the input array elements
Output value outGroupedElements Array<Array<Type> >& List of input elements for each case
Output value outGroupedIndices Array<Array<int> >& List of input element indices for each case

Errors

List of possible exceptions:

Error type Description
DomainError Inconsistent array lengths on input in GroupByCase.