You are here: Start » Function Reference » Loop Generators » EnumerateIntegers

EnumerateIntegers

This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

In each consecutive iteration produces a consecutive number from an arithmetic sequence.

Syntax

bool avl::EnumerateIntegers
(
	Enumerate1DState& ioState,
	int inStart,
	atl::Optional<int> inCount,
	int inStep,
	int& outValue
)

Parameters

	Name	Type	Range	Default	Description
	ioState	Enumerate1DState&			Object used to maintain state of the function.
	inStart	int		0	First value of the generated sequence
	inCount	Optional<int>	0 -	NIL	Length of the generated sequence
	inStep	int		1	Value added in each iteration
	outValue	int&