Back to FabImage Library websiteYou are here:
Start »
Function Reference »
All Functions »
Conditional Processing »
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: |
fil |
Module: |
FoundationLite |
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 fil::GroupByCase_Synchronized
(
const ftl::Array<Type>& inArray,
const ftl::Array<int>& inCaseIndices,
const int inCaseCount,
ftl::Array<ftl::Array<Type> >& outGroupedElements,
ftl::Array<ftl::Array<int> >& outGroupedIndices
)
Parameters
|
Name |
Type |
Range |
Default |
Description |
 |
inArray |
const Array<Type>& |
|
|
Elements to be grouped |
 |
inCaseIndices |
const Array<int>& |
|
|
Reference values corresponding to the input array elements |
 |
inCaseCount |
const int |
0 -  |
|
Number of cases, each of which is between 0 and inCaseCount - 1 inclusive |
 |
outGroupedElements |
Array<Array<Type> >& |
|
|
List of input elements for each case |
 |
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. |