Back to Aurora Vision Library website

You are here: Start » Function Reference » All Functions » Array Basics » AvsFilter_SetMultipleArrayElements

AvsFilter_SetMultipleArrayElements


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
Module: FoundationLite

Sets elements of an array to new values.

Syntax

void avs::AvsFilter_SetMultipleArrayElements
(
	atl::Array<Type>& ioArray,
	const atl::Array<int>& inIndices,
	bool inInverse,
	const atl::Array<Type>& inNewValues
)

Parameters

Name Type Default Description
Input will be modified ioArray Array<Type>&
Input value inIndices const Array<int>& Indices within the array
Input value inInverse bool False Determines if the indices are counted from beginning or from end of the input array
Input value inNewValues const Array<Type>& Values to be set

Examples
inArray = {1,4,3,2,5}
inIndices = {0,2,4}
inNewValues = {8,7,6} 		outArray = {8,4,7,2,6}

Errors

List of possible exceptions:

Error type Description
DomainError Inconsistent array lengths in SetMultipleArrayElements.
DomainError Index out of range in SetMultipleArrayElements.

See Also