it.unimi.dsi.fastutil.longs

Class LongBigSpliterators.LateBindingSizeIndexBasedSpliterator

java.lang.Object

it.unimi.dsi.fastutil.longs.AbstractLongSpliterator

it.unimi.dsi.fastutil.longs.LongBigSpliterators.AbstractIndexBasedSpliterator

it.unimi.dsi.fastutil.longs.LongBigSpliterators.LateBindingSizeIndexBasedSpliterator

All Implemented Interfaces:

it.unimi.dsi.fastutil.longs.LongSpliterator, java.util.Spliterator<java.lang.Long>, java.util.Spliterator.OfLong, java.util.Spliterator.OfPrimitive<java.lang.Long,java.util.function.LongConsumer,java.util.Spliterator.OfLong>

Enclosing class:

LongBigSpliterators

public abstract static class LongBigSpliterators.LateBindingSizeIndexBasedSpliterator
extends LongBigSpliterators.AbstractIndexBasedSpliterator

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

This class implements a late binding strategy. On a new, non-split instance, the max pos will track the given data store (usually it's size, hence the class' name). On the first split, the last index will be read from the backing data store one last time and then be fixed for the remaining duration of this instance.
The returned split should should also be have a constant maxPos.

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).

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

Modifier and Type	Field and Description
protected long	maxPos The maximum LongBigSpliterators.AbstractIndexBasedSpliterator.pos can be, or -1 if it hasn't been fixed yet.

Fields inherited from class it.unimi.dsi.fastutil.longs.LongBigSpliterators.AbstractIndexBasedSpliterator

pos

Fields inherited from interface java.util.Spliterator

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LateBindingSizeIndexBasedSpliterator(long initialPos)
protected	LateBindingSizeIndexBasedSpliterator(long initialPos, long fixedMaxPos)

Method Summary

Modifier and Type	Method and Description
protected long	getMaxPos() The maximum pos can be, and is the logical end (exclusive) of the "range".
protected abstract long	getMaxPosFromBackingStore() Return the maximum pos can be dynamically tracking the backing data store.
it.unimi.dsi.fastutil.longs.LongSpliterator	trySplit()

Methods inherited from class it.unimi.dsi.fastutil.longs.LongBigSpliterators.AbstractIndexBasedSpliterator

characteristics, computeSplitPoint, estimateSize, forEachRemaining, get, makeForSplit, skip, tryAdvance

Methods inherited from class it.unimi.dsi.fastutil.longs.AbstractLongSpliterator

forEachRemaining, tryAdvance

Methods inherited from class java.lang.Object

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

Methods inherited from interface it.unimi.dsi.fastutil.longs.LongSpliterator

forEachRemaining, getComparator, tryAdvance

Methods inherited from interface java.util.Spliterator

getExactSizeIfKnown, hasCharacteristics

Field Detail

maxPos

protected long maxPos

The maximum LongBigSpliterators.AbstractIndexBasedSpliterator.pos can be, or -1 if it hasn't been fixed yet.

Constructor Detail

LateBindingSizeIndexBasedSpliterator

protected LateBindingSizeIndexBasedSpliterator(long initialPos)

LateBindingSizeIndexBasedSpliterator

protected LateBindingSizeIndexBasedSpliterator(long initialPos,
                                               long fixedMaxPos)

Method Detail

getMaxPosFromBackingStore

protected abstract long getMaxPosFromBackingStore()

Return the maximum pos can be dynamically tracking the backing data store.

This method will be the return value of getMaxPos() until this spliterator is trySplit() split, in which case its final return value will be saved and remain constant for the rest of the duration of this instance.

getMaxPos

protected final long getMaxPos()

Description copied from class: LongBigSpliterators.AbstractIndexBasedSpliterator

The maximum pos can be, and is the logical end (exclusive) of the "range".

If pos is equal to the return of this method, this means the last element has been returned and the next call to LongBigSpliterators.AbstractIndexBasedSpliterator.tryAdvance(java.util.function.LongConsumer) will return false.

Usually set return the parent collection's size, but does not have to be (for example, sublists and subranges).

This method allows the implementation to decide how it binds on the size (late or early). However, LongBigSpliterators.EarlyBindingSizeIndexBasedSpliterator and LongBigSpliterators.LateBindingSizeIndexBasedSpliterator give an implementation of this method for the two most common strategies.

Specified by:

getMaxPos in class LongBigSpliterators.AbstractIndexBasedSpliterator

trySplit

public it.unimi.dsi.fastutil.longs.LongSpliterator trySplit()

Description copied from class: LongBigSpliterators.AbstractIndexBasedSpliterator

Specified by:

trySplit in interface it.unimi.dsi.fastutil.longs.LongSpliterator

Specified by:

trySplit in interface java.util.Spliterator<java.lang.Long>

Specified by:

trySplit in interface java.util.Spliterator.OfLong

Specified by:

trySplit in interface java.util.Spliterator.OfPrimitive<java.lang.Long,java.util.function.LongConsumer,java.util.Spliterator.OfLong>

Overrides:

trySplit in class LongBigSpliterators.AbstractIndexBasedSpliterator