Back to Adaptive Vision Library Lite website

You are here: Start » All Functions » Array Composition » RemoveRangeFromArray

RemoveRangeFromArray


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

Removes elements at the given indices from the input array.

Syntax

void avl::RemoveRangeFromArray
(
	atl::Array<Type>& ioArray,
	int inStart,
	atl::Optional<int> inLength,
	bool inInverse
)

Parameters

Name Type Range Default Description
ioArray Array<Type>&
inStart int 0 - Index of the first element to be removed
inLength Optional<int> 0 - NIL Number of elements to be removed
inInverse bool False Determines if the indices are counted from beginning or from end of the input array

Description

The operation removes a range of elements from inArray. Removed are the elements at indices from inStart to inStart + inLength - 1.

Examples
inArray = {6,7,3,4,10}
inStart = 1
inLength = 2 		outArray = {6,4,10}

Errors

List of possible exceptions:

Error type Description
DomainError Index out of range in RemoveRangeFromArray.
DomainError Negative inLength in RemoveRangeFromArray.
DomainError Negative inStart in RemoveRangeFromArray.

See Also

  • RemoveValueFromArray – Removes the first or all of the elements of the given value from an array.