org.beryx.streamplify

Class LongIndexedSpliterator<T,S extends LongIndexedSpliterator<T,S>>

java.lang.Object

org.beryx.streamplify.LongIndexedSpliterator<T,S>

All Implemented Interfaces:

java.util.Spliterator<T>, Streamable<T,S>

Direct Known Subclasses:

LongCartesianProduct, LongCombinations, LongDerangements, LongPartialPermutations, LongPermutations, LongPowerSet

public class LongIndexedSpliterator<T,S extends LongIndexedSpliterator<T,S>>
extends java.lang.Object
implements java.util.Spliterator<T>, Streamable<T,S>

An indexed-spliterator that uses a long index.

Nested Class Summary

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

java.util.Spliterator.OfDouble, java.util.Spliterator.OfInt, java.util.Spliterator.OfLong, java.util.Spliterator.OfPrimitive<T,T_CONS,T_SPLITR extends java.util.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	LongIndexedSpliterator(long origin, long fence)

Method Summary

Modifier and Type	Method and Description
java.math.BigInteger	bigCount()
int	characteristics()
long	count()
long	estimateSize()
void	forEachRemaining(java.util.function.Consumer<? super T> action)
protected long	getFence()
protected long	getIndex()
java.util.stream.Stream<T>	parallelStream()
S	shuffle(java.util.Random rnd) Configure this instance to provide streams that shuffle elements in the data source.
S	skip(java.math.BigInteger bigN) Configure this instance to provide streams that skip the first {}@code n} elements in the data source.
S	skip(long n) Configure this instance to provide streams that skip the first {}@code n} elements in the data source.
java.util.stream.Stream<T>	stream()
boolean	tryAdvance(java.util.function.Consumer<? super T> action)
java.util.Spliterator<T>	trySplit()
S	withAdditionalCharacteristics(int additionalCharacteristics) Adds additionalCharacteristics to the provided streams.
S	withShuffler(LongShuffler shuffler) Configures the shuffler of this source.
S	withValueSupplier(Splittable.LongIndexed<T> valueSupplier) Configures the value supplier of this source.

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

getComparator, getExactSizeIfKnown, hasCharacteristics

Methods inherited from interface org.beryx.streamplify.Streamable

ordered, shuffle

Constructor Detail

LongIndexedSpliterator

protected LongIndexedSpliterator(long origin,
                                 long fence)

Method Detail

withAdditionalCharacteristics

public final S withAdditionalCharacteristics(int additionalCharacteristics)

Description copied from interface: Streamable

Adds additionalCharacteristics to the provided streams.

Specified by:

withAdditionalCharacteristics in interface Streamable<T,S extends LongIndexedSpliterator<T,S>>

Returns:

this instance

withShuffler

public final S withShuffler(LongShuffler shuffler)

Configures the shuffler of this source. Unless you provide your own LongShuffler implementation, you should use Streamable.shuffle() or shuffle(Random) instead of this method.

Returns:

this instance

withValueSupplier

public final S withValueSupplier(Splittable.LongIndexed<T> valueSupplier)

Configures the value supplier of this source.

Returns:

this instance

getIndex

protected final long getIndex()

getFence

protected final long getFence()

stream

public java.util.stream.Stream<T> stream()

Specified by:

stream in interface Streamable<T,S extends LongIndexedSpliterator<T,S>>

Returns:

a sequential Stream

parallelStream

public java.util.stream.Stream<T> parallelStream()

Specified by:

parallelStream in interface Streamable<T,S extends LongIndexedSpliterator<T,S>>

Returns:

a possibly parallel Stream

count

public long count()

Specified by:

count in interface Streamable<T,S extends LongIndexedSpliterator<T,S>>

Returns:

the number of elements in the data source, or -1 if the number is too big to fit in a long.

bigCount

public java.math.BigInteger bigCount()

Specified by:

bigCount in interface Streamable<T,S extends LongIndexedSpliterator<T,S>>

Returns:

the number of elements in the data source as BigInteger.

skip

public S skip(long n)

Description copied from interface: Streamable

Configure this instance to provide streams that skip the first {}@code n} elements in the data source. It is usually more efficient to call this method instead of Stream.skip(long).

Specified by:

skip in interface Streamable<T,S extends LongIndexedSpliterator<T,S>>

Parameters:

n - the number of elements to be skipped (as a long).

Returns:

depending on the implementation, it may return this instance or another Streamable.

skip

public S skip(java.math.BigInteger bigN)

Description copied from interface: Streamable

Configure this instance to provide streams that skip the first {}@code n} elements in the data source.

Specified by:

skip in interface Streamable<T,S extends LongIndexedSpliterator<T,S>>

Parameters:

bigN - the number of elements to be skipped (as a BigInteger).

Returns:

depending on the implementation, it may return this instance or another Streamable.

estimateSize

public long estimateSize()

Specified by:

estimateSize in interface java.util.Spliterator<T>

characteristics

public int characteristics()

Specified by:

characteristics in interface java.util.Spliterator<T>

tryAdvance

public boolean tryAdvance(java.util.function.Consumer<? super T> action)

Specified by:

tryAdvance in interface java.util.Spliterator<T>

trySplit

public java.util.Spliterator<T> trySplit()

Specified by:

trySplit in interface java.util.Spliterator<T>

forEachRemaining

public void forEachRemaining(java.util.function.Consumer<? super T> action)

Specified by:

forEachRemaining in interface java.util.Spliterator<T>

shuffle

public S shuffle(java.util.Random rnd)

Description copied from interface: Streamable

Configure this instance to provide streams that shuffle elements in the data source.

Specified by:

shuffle in interface Streamable<T,S extends LongIndexedSpliterator<T,S>>

Parameters:

rnd - the random number generator to be used to perform the shuffling.

Returns:

depending on the implementation, it may return this instance or another Streamable.