Back to Aurora Vision Library website
You are here: Start » Function Reference » Data Flow » Loop Generators » EnumerateCombinations
EnumerateCombinations
Header: | STD.h |
---|---|
Namespace: | avl |
Module: | FoundationLite |
In each consecutive iteration produces a consecutive combination of integer numbers.
Syntax
bool avl::EnumerateCombinations ( EnumerateCombinationsState& ioState, int inCombinationSize, int inSetSize, bool inRepeat, atl::Array<int>& outCombination, int& outIndex )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
ioState | EnumerateCombinationsState& | Object used to maintain state of the function. | |||
inCombinationSize | int | 0 - | 2 | ||
inSetSize | int | 0 - | 3 | ||
inRepeat | bool | Determines whether to repeat loop | |||
outCombination | Array<int>& | ||||
outIndex | int& |
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Combination size cannot be greater than the set size in EnumerateCombinations. |