You are here: Start » Function Reference » All Functions » Loop Generators » EnumerateElementPairs

EnumerateElementPairs

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

Produces a total number of 'inCount1 * inCount2' of pairs of elements.

Syntax

void avl::EnumerateElementPairs
(
	const atl::Array<T>& inArray1,
	int inStart1,
	atl::Optional<int> inCount1,
	const atl::Array<T>& inArray2,
	int inStart2,
	atl::Optional<int> inCount2,
	bool inRepeat,
	T& outElement1,
	T& outElement2,
	int& outIndex1,
	int& outIndex2
)

Parameters

Name	Type	Range	Default	Description
inArray1	const Array<T>&			First input array
inStart1	int	0 -		Index of the first element of first array to be enumerated.
inCount1	Optional<int>	0 -	NIL	Number of elements from first array to be enumerated. Leave 'Auto' to enumerate to the end of the input array.
inArray2	const Array<T>&			Second input array
inStart2	int	0 -		Index of the first element of second array to be enumerated.
inCount2	Optional<int>	0 -	NIL	Number of elements from second array to be enumerated. Leave 'Auto' to enumerate to the end of the input array.
inRepeat	bool			Determines whether to repeat loop
outElement1	T&			Element from the first array
outElement2	T&			Element from the second array
outIndex1	int&			Index of the output element from first array
outIndex2	int&			Index of the output element from second array