cc.redberry.combinatorics

Class IntCompositions

java.lang.Object

cc.redberry.combinatorics.IntCompositions

All Implemented Interfaces:

IntCombinatorialPort, Serializable

public final class IntCompositions
extends Object
implements IntCombinatorialPort

Iterator over all compositions of specified integer into N parts.

Implementation note: the description of the algorithm can be found here https://stackoverflow.com/a/6609080/946635

Since:

2.0

Author:

Stanislav Poslavsky

See Also:

Serialized Form

Nested Class Summary

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

IntCombinatorialPort.Iterator

Constructor Summary

Constructors

Constructor and Description
IntCompositions(int integer, int nCompositions)

Method Summary

Modifier and Type	Method and Description
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

Constructor Detail

IntCompositions

public IntCompositions(int integer,
                       int nCompositions)

Method Detail

reset

public void reset()

Description copied from interface: IntCombinatorialPort

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

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