ball.util

Class DispatchSpliterator<T>

java.lang.Object

java.util.Spliterators.AbstractSpliterator<T>

ball.util.DispatchSpliterator<T>

All Implemented Interfaces:

Spliterator<T>

public abstract class DispatchSpliterator<T>
extends Spliterators.AbstractSpliterator<T>

Spliterator abstract base class that dispatches to Spliterators supplied through an Spliterator of Spliterator Suppliers.

Version:

$Revision: 6137 $

Author:

Allen D. Ball

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Spliterator

Spliterator.OfDouble, Spliterator.OfInt, Spliterator.OfLong, Spliterator.OfPrimitive<T,T_CONS,T_SPLITR extends Spliterator.OfPrimitive<T,T_CONS,T_SPLITR>>

Field Summary

Fields inherited from interface java.util.Spliterator

CONCURRENT, DISTINCT, IMMUTABLE, NONNULL, ORDERED, SIZED, SORTED, SUBSIZED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DispatchSpliterator(long estimate, int characteristics) See Spliterators.AbstractSpliterator constructor.

Method Summary

Modifier and Type	Method and Description
protected static long	binomial(long n, long k) Method to count the number of combinations of k-size that may be chosen from a set of n-size (binomial coefficient).
protected static long	binomial(long n, long k0, long kN) Method to count the number of combinations of [k0,kN] size that may be chosen from a set of n-size (binomial coefficient).
protected abstract Spliterator<Supplier<Spliterator<T>>>	spliterators() Method to provide the Spliterator Suppliers.
boolean	tryAdvance(Consumer<? super T> consumer)
Spliterator<T>	trySplit()

Methods inherited from class java.util.Spliterators.AbstractSpliterator

characteristics, estimateSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Spliterator

forEachRemaining, getComparator, getExactSizeIfKnown, hasCharacteristics

Constructor Detail

DispatchSpliterator

protected DispatchSpliterator(long estimate,
                              int characteristics)

See Spliterators.AbstractSpliterator constructor.

Parameters:

estimate - The estimated size of this Spliterator if known, otherwise Long.MAX_VALUE.

characteristics - Properties of this Spliterator's source or elements. If Spliterator.SIZED is reported then this Spliterator will additionally report Spliterator.SUBSIZED.

Method Detail

spliterators

protected abstract Spliterator<Supplier<Spliterator<T>>> spliterators()

Method to provide the Spliterator Suppliers. This method is called sometime after the first call to tryAdvance(Consumer).

Returns:

The Iterator of Spliterator Suppliers.

trySplit

public Spliterator<T> trySplit()

Specified by:

trySplit in interface Spliterator<T>

Overrides:

trySplit in class Spliterators.AbstractSpliterator<T>

tryAdvance

public boolean tryAdvance(Consumer<? super T> consumer)

binomial

protected static long binomial(long n,
                               long k0,
                               long kN)

Method to count the number of combinations of [k0,kN] size that may be chosen from a set of n-size (binomial coefficient).

Parameters:

n - The size of the set.

k0 - The beginning of the interval (inclusive) of size of the subsets to be chosen.

kN - The end of the interval (inclusive) of size of the subsets to be chosen.

Returns:

The total number of combinations.

binomial

protected static long binomial(long n,
                               long k)

Method to count the number of combinations of k-size that may be chosen from a set of n-size (binomial coefficient).

Parameters:

n - The size of the set.

k - The size of the subset to be chosen.

Returns:

The total number of k-combinations.