Package cc.redberry.combinatorics

Class IntTuples

java.lang.Object

cc.redberry.combinatorics.IntTuples

All Implemented Interfaces:

IntCombinatorialPort, Serializable

public final class IntTuples
extends Object
implements IntCombinatorialPort

Iterator over all N-tuples (not necessary to be distinct), which can be chosen from N arrays of integers of the form array_i = [0, 1, 2, ..., K_i].
For example, if a set of arrays length is {K_i} = [2,3,2], then the following tuples will be produced

    arr      lastUpdateDepth
 [0, 0, 0]          0
 [0, 0, 1]          2
 [0, 1, 0]          1
 [0, 1, 1]          2
 [0, 2, 0]          1
 [0, 2, 1]          2
 [1, 0, 0]          0
 [1, 0, 1]          2
 [1, 1, 0]          1
 [1, 1, 1]          2
 [1, 2, 0]          1
 [1, 2, 1]          2
 

Calculation of the next tuple occurs only on the invocation of take().

Note: method take() returns the same reference on each invocation.

Since:

1.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface cc.redberry.combinatorics.IntCombinatorialPort

IntCombinatorialPort.Iterator

Field Summary

Fields

Modifier and Type	Field	Description
private int[]	current
private int	lastUpdateDepth
private static final long	serialVersionUID
private final int[]	upperBounds

Constructor Summary

Constructors

Constructor	Description
IntTuples(int... upperBounds)

Method Summary

Modifier and Type	Method	Description
private static void	checkWithException(int[] upperBounds)
int	getLastUpdateDepth()
int[]	getReference()	Returns the reference to the current iteration element
void	reset()	Resets the iteration
int[]	take()	Calculates and returns the next combination or null, if no more combinations exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

upperBounds

private final int[] upperBounds

current

private int[] current

lastUpdateDepth

private int lastUpdateDepth

Constructor Details

IntTuples

public IntTuples(int... upperBounds)

Method Details

checkWithException

private static void checkWithException(int[] upperBounds)

take

public int[] take()

Description copied from interface: IntCombinatorialPort

Calculates and returns the next combination or null, if no more combinations exist.

Specified by:

take in interface IntCombinatorialPort

Returns:

the next combination or null, if no more combinations exist

getLastUpdateDepth

public int getLastUpdateDepth()

reset

public void reset()

Resets the iteration

Specified by:

reset in interface IntCombinatorialPort

getReference

public int[] getReference()

Description copied from interface: IntCombinatorialPort

Returns the reference to the current iteration element

Specified by:

getReference in interface IntCombinatorialPort

Returns:

the reference to the current iteration element