Back to FabImage Library website
You are here: Start » Function Reference » All Functions » Array Basics » FisFilter_GetMultipleArrayElements
FisFilter_GetMultipleArrayElements
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: | fis |
| Module: | FoundationLite |
Extracts multiple elements from an array.
Syntax
void fis::FisFilter_GetMultipleArrayElements ( const ftl::Array<Type>& inArray, const ftl::Array<int>& inIndices, bool inInverse, ftl::Array<Type>& outValues )
Parameters
| Name | Type | Default | Description | |
|---|---|---|---|---|
 |
inArray | const Array<Type>& | Input array | |
|
inIndices | const Array<int>& | Indices within the array | |
|
inInverse | bool | Determines if the indices are counted from beginning or from end of the input array | |
 |
outValues | Array<Type>& | Output values |
Hints
- When you need only one array element, use FisFilter_GetArrayElement instead.
- When you need a continuous subsequence of array elements, use CropArray.
Examples
|
|
|
inArray = {100, 430, 35, 250, 55, 130} inIndices = {2, 4, 3, 3} |
outValues = {35, 55, 250, 250} |
Errors
List of possible exceptions:
| Error type | Description |
|---|---|
| DomainError | Index out of range in GetMultipleArrayElements. |
See Also
- FisFilter_GetArrayElement – Extracts a single element from an array at the specified index.
- FisFilter_GetArrayElements – Extracts up to 8 individual elements from an array.
- CropArray – Selects a continuous subsequence of array elements.
