org.beryx.streamplify

Interface IntArraySupplier

All Known Implementing Classes:

CartesianProductSupplier, CartesianProductSupplier.BigInt, CartesianProductSupplier.Long, CombinationSupplier, CombinationSupplier.BigInt, CombinationSupplier.Long, DerangementSupplier, DerangementSupplier.BigInt, DerangementSupplier.Long, PartialPermutationSupplier, PartialPermutationSupplier.BigInt, PartialPermutationSupplier.Long, PermutationSupplier, PermutationSupplier.BigInt, PermutationSupplier.Long, PowerSetSupplier, PowerSetSupplier.BigInt, PowerSetSupplier.Long

public interface IntArraySupplier

This interface acts as a trait that helps implementing the valueSupplier requested by indexed-spliterators (such as LongIndexedSpliterator or BigIntegerIndexedSpliterator) with the type parameter int[].
There is an implicit assumption that the implementing class uses an index (or some similar information) in order to decide whether the value to be supplied can be computed based on the previous value or based on the index.

Method Summary

Modifier and Type	Method and Description
void	computeNext() Computes the value to be supplied next, using the currently supplied value.
int[]	getCurrentSequence()
default int[]	getNextSequence(boolean useNext) Retrieves the next value to be supplied.
int[]	unrank()

Method Detail

getCurrentSequence

int[] getCurrentSequence()

Returns:

the current sequence provided by this value supplier

computeNext

void computeNext()

Computes the value to be supplied next, using the currently supplied value. The next call of getCurrentSequence() should return this newly computed value.

unrank

int[] unrank()

Returns:

the next value to be supplied. It is assumed that the next value cannot be obtained using the current one, but it has to be computed based on an index (or some similar information) handled by the implementing class.

getNextSequence

default int[] getNextSequence(boolean useNext)

Retrieves the next value to be supplied. Postcondition: a call to getCurrentSequence() will return an equal (but not identical) value.

Parameters:

useNext - true, if the next value can be computed based on the current one;

Returns:

the next value to be supplied. This should not be a reference to the array that backs getCurrentSequence().