Back to Aurora Vision Library Lite website

You are here: Start » All Functions » Conditional Processing » GroupByCase_Synchronized

GroupByCase_Synchronized


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

Groups the elements of the input array into output arrays, depending on the associated array of case indices. Assumes that the range of case indices is continuous and starts at zero.

Syntax

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

Parameters

Name Type Range 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
Input value inCaseCount const int 0 - Number of cases, each of which is between 0 and inCaseCount - 1 inclusive
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_Synchronized.
DomainError Incorrect case index in GroupByCase_Synchronized.