Back to Aurora Vision Library Lite website
You are here: Start » All Functions » Array Composition » AvsFilter_InsertArrayToArray
AvsFilter_InsertArrayToArray
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: | avs |
Inserts an array at the specified index of another array.
Syntax
void avs::AvsFilter_InsertArrayToArray ( atl::Array<Type>& ioArray, const atl::Array<Type>& inInsertedArray, int inIndex, bool inInverse )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
ioArray | Array<Type>& | |||
inInsertedArray | const Array<Type>& | Input array to be inserted | ||
inIndex | int | Input index within the inArray at which the first element of the inInsertedArray will be placed | ||
inInverse | bool | False | Determines if the indices are counted from beginning or from end of the input array |
Examples
inArray = {1,2,3,4,5} inInsertedArray = {10,9} inIndex = 1 |
outArray = {1,10,9,2,3,4,5} |
inArray = {1,2,3,4,5} inInsertedArray = {10,9} inIndex = 5 |
outArray = {1,2,3,4,5,10,9} |
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Index out of range in InsertArrayToArray. |
See Also
- AvsFilter_InsertToArray – Inserts a new element to an array at a specified location.
- FlattenArray – Receives an array of arrays, and creates a single one-dimensional array containing all individual elements.