it.unimi.dsi.fastutil.objects

Class ObjectSpliterators.EarlyBindingSizeIndexBasedSpliterator<K>

java.lang.Object

it.unimi.dsi.fastutil.objects.AbstractObjectSpliterator<K>

it.unimi.dsi.fastutil.objects.ObjectSpliterators.AbstractIndexBasedSpliterator<K>

it.unimi.dsi.fastutil.objects.ObjectSpliterators.EarlyBindingSizeIndexBasedSpliterator<K>

All Implemented Interfaces:

it.unimi.dsi.fastutil.objects.ObjectSpliterator<K>, java.util.Spliterator<K>

Enclosing class:

ObjectSpliterators

public abstract static class ObjectSpliterators.EarlyBindingSizeIndexBasedSpliterator<K>
extends ObjectSpliterators.AbstractIndexBasedSpliterator<K>

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 an early binding strategy for getMaxPos(). The last index this spliterator covers is fixed at construction time and does not vary on changes to the backing data store. This should usually be the size of the backing data store (until a split at least), hence the class' name, but this is not required.

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 int	maxPos The maximum ObjectSpliterators.AbstractIndexBasedSpliterator.pos can be

Fields inherited from class it.unimi.dsi.fastutil.objects.ObjectSpliterators.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	EarlyBindingSizeIndexBasedSpliterator(int initialPos, int maxPos)

Method Summary

Modifier and Type	Method and Description
protected int	getMaxPos() The maximum pos can be, and is the logical end (exclusive) of the "range".

Methods inherited from class it.unimi.dsi.fastutil.objects.ObjectSpliterators.AbstractIndexBasedSpliterator

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

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

Field Detail

maxPos

protected final int maxPos

The maximum ObjectSpliterators.AbstractIndexBasedSpliterator.pos can be

Constructor Detail

EarlyBindingSizeIndexBasedSpliterator

protected EarlyBindingSizeIndexBasedSpliterator(int initialPos,
                                                int maxPos)

Method Detail

getMaxPos

protected final int getMaxPos()

Description copied from class: ObjectSpliterators.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 ObjectSpliterators.AbstractIndexBasedSpliterator.tryAdvance(java.util.function.Consumer<? super K>) 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, ObjectSpliterators.EarlyBindingSizeIndexBasedSpliterator and ObjectSpliterators.LateBindingSizeIndexBasedSpliterator give an implementation of this method for the two most common strategies.

Specified by:

getMaxPos in class ObjectSpliterators.AbstractIndexBasedSpliterator<K>