Back to FabImage Library website

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

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

Syntax

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

Parameters

Name Type Range Default Description
Input value inArray1 const Array<T>& First input array
Input value inStart1 int 0 - Index of the first element of first array to be enumerated.
Input value 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.
Input value inArray2 const Array<T>& Second input array
Input value inStart2 int 0 - Index of the first element of second array to be enumerated.
Input value 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.
Input value inRepeat bool Determines whether to repeat loop
Output value outElement1 T& Element from the first array
Output value outElement2 T& Element from the second array
Output value outIndex1 int& Index of the output element from first array
Output value outIndex2 int& Index of the output element from second array