Class ShortBigSpliterators.AbstractIndexBasedSpliterator

java.lang.Object

it.unimi.dsi.fastutil.shorts.AbstractShortSpliterator

it.unimi.dsi.fastutil.shorts.ShortBigSpliterators.AbstractIndexBasedSpliterator

All Implemented Interfaces:

ShortSpliterator, Spliterator<Short>, Spliterator.OfPrimitive<Short, ShortConsumer, ShortSpliterator>

Direct Known Subclasses:

ShortBigSpliterators.EarlyBindingSizeIndexBasedSpliterator, ShortBigSpliterators.LateBindingSizeIndexBasedSpliterator

Enclosing class:

ShortBigSpliterators

public abstract static class ShortBigSpliterators.AbstractIndexBasedSpliterator
extends AbstractShortSpliterator

A skeletal implementation for a spliterator backed by an index based data store. High performance concrete implementations (like the main Spliterator of BigArrayBigList) generally should avoid using this and just implement the interface directly, but should be decent for less performance critical implementations.

As the abstract methods in this class are used in inner loops, it is generally a good idea to override the class as final as to encourage the JVM to inline them (or alternatively, override the abstract methods as final).

Since:

8.5.0

Author:

C. Sean Young <csyoung@google.com>

Nested Class Summary

Nested classes/interfaces inherited from interface Spliterator

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

Field Summary

Fields inherited from interface Spliterator

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

Method Summary

Modifier and Type	Method	Description
int	characteristics()
long	estimateSize()
void	forEachRemaining(ShortConsumer action)
long	skip(long n)	Skips the given number of elements.
boolean	tryAdvance(ShortConsumer action)
ShortSpliterator	trySplit()

Methods inherited from class Object

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

Methods inherited from interface ShortSpliterator

forEachRemaining, getComparator, tryAdvance

Methods inherited from interface Spliterator

getExactSizeIfKnown, hasCharacteristics

Method Details

characteristics

public int characteristics()

estimateSize

public long estimateSize()

tryAdvance

public boolean tryAdvance(ShortConsumer action)

forEachRemaining

public void forEachRemaining(ShortConsumer action)

skip

public long skip(long n)

Description copied from interface: ShortSpliterator

Skips the given number of elements.

The effect of this call is exactly the same as that of calling ShortSpliterator.tryAdvance(Consumer) for n times (possibly stopping if ShortSpliterator.tryAdvance(Consumer) returns false). The action called will do nothing; elements will be discarded.

Parameters:

n - the number of elements to skip.

Returns:

the number of elements actually skipped.

See Also:

• Spliterator.tryAdvance(Consumer)

trySplit

public ShortSpliterator trySplit()

Throws:

IndexOutOfBoundsException - if the return of computeSplitPoint() was < pos or > {@link #getMaxPos()}.

Implementation Specification:

This implementation always returns a prefix of the elements, in order to comply with the Spliterator.ORDERED property. This means this current iterator does not need to to update what getMaxPos() returns in response to this method (but it may do "book-keeping" on it based on binding strategy).

The split point is computed by computeSplitPoint(); see that method for details.