Package it.unimi.dsi.fastutil.shorts

Class ShortSpliterators

java.lang.Object
it.unimi.dsi.fastutil.shorts.ShortSpliterators
public final class ShortSpliterators
extends java.lang.Object
A class providing static methods and objects that do useful things with type-specific spliterators.
Since:
8.5.0
Author:
C. Sean Young <csyoung@google.com>
See Also:
Spliterators

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  ShortSpliterators.AbstractIndexBasedSpliterator
    A skeletal implementation for a spliterator backed by an index based data store.
    static class  ShortSpliterators.EarlyBindingSizeIndexBasedSpliterator
    A skeletal implementation for a spliterator backed by an index based data store.
    static class  ShortSpliterators.EmptySpliterator
    A class returning no elements and a type-specific spliterator interface.
    static class  ShortSpliterators.LateBindingSizeIndexBasedSpliterator
    A skeletal implementation for a spliterator backed by an index based data store.

  • Field Summary

    Fields
    Modifier and Type Field Description
    static int COLLECTION_SPLITERATOR_CHARACTERISTICS  
    static ShortSpliterators.EmptySpliterator EMPTY_SPLITERATOR
    An empty spliterator.
    static int LIST_SPLITERATOR_CHARACTERISTICS  
    static int SET_SPLITERATOR_CHARACTERISTICS  
    static int SORTED_SET_SPLITERATOR_CHARACTERISTICS  

  • Method Summary

    Modifier and Type Method Description
    static it.unimi.dsi.fastutil.shorts.ShortIterator asIterator​(it.unimi.dsi.fastutil.shorts.ShortSpliterator spliterator)
    Wrap a type-specific Spliterator as a type-specific Iterator
    static it.unimi.dsi.fastutil.shorts.ShortSpliterator asShortSpliterator​(java.util.Spliterator i)
    Wraps a standard spliterator into a type-specific spliterator.
    static it.unimi.dsi.fastutil.shorts.ShortSpliterator asShortSpliterator​(java.util.Spliterator i, ShortComparator comparatorOverride)
    Wraps a standard spliterator into a type-specific spliterator.
    static it.unimi.dsi.fastutil.shorts.ShortSpliterator asSpliterator​(it.unimi.dsi.fastutil.shorts.ShortIterator iter, long size, int additionalCharacterisitcs)
    Wrap a type-specific Iterator of a known size as a type-specific Spliterator
    static it.unimi.dsi.fastutil.shorts.ShortSpliterator asSpliteratorFromSorted​(it.unimi.dsi.fastutil.shorts.ShortIterator iter, long size, int additionalCharacterisitcs, ShortComparator comparator)
    Wrap a type-specific, sorted Iterator of a known size as a type-specific Spliterator
    static it.unimi.dsi.fastutil.shorts.ShortSpliterator asSpliteratorFromSortedUnknownSize​(it.unimi.dsi.fastutil.shorts.ShortIterator iter, int additionalCharacterisitcs, ShortComparator comparator)
    Wrap a type-specific, sorted Iterator of an unknown size as a type-specific Spliterator
    static it.unimi.dsi.fastutil.shorts.ShortSpliterator asSpliteratorUnknownSize​(it.unimi.dsi.fastutil.shorts.ShortIterator iter, int characterisitcs)
    Wrap a type-specific Iterator of an unknown size as a type-specific Spliterator
    static it.unimi.dsi.fastutil.shorts.ShortSpliterator concat​(it.unimi.dsi.fastutil.shorts.ShortSpliterator... a)
    Concatenates all spliterators contained in an array.
    static it.unimi.dsi.fastutil.shorts.ShortSpliterator concat​(it.unimi.dsi.fastutil.shorts.ShortSpliterator[] a, int offset, int length)
    Concatenates a sequence of spliterators contained in an array.
    static it.unimi.dsi.fastutil.shorts.ShortSpliterator fromTo​(short from, short to)
    Creates a type-specific spliterator over an interval.
    static it.unimi.dsi.fastutil.shorts.ShortSpliterator narrow​(java.util.Spliterator.OfInt i)
    Wrap a JDK primitive spliterator to a type-specific spliterator, making checked narrowed casts.
    static void onEachMatching​(it.unimi.dsi.fastutil.shorts.ShortSpliterator spliterator, ShortPredicate predicate, ShortConsumer action)
    Perform the given action on each element that matches the given predicate.
    static void onEachMatching​(it.unimi.dsi.fastutil.shorts.ShortSpliterator spliterator, java.util.function.IntPredicate predicate, java.util.function.IntConsumer action)
    Perform the given action on each element that matches the given predicate.
    static it.unimi.dsi.fastutil.shorts.ShortSpliterator singleton​(short element)
    Returns a spliterator that iterates just over the given element.
    static it.unimi.dsi.fastutil.shorts.ShortSpliterator singleton​(short element, ShortComparator comparator)
    Returns a spliterator that iterates just over the given element.
    static it.unimi.dsi.fastutil.ints.IntSpliterator widen​(it.unimi.dsi.fastutil.shorts.ShortSpliterator i)
    Wrap a type-specific spliterator to a JDK compatible primitive spliterator.
    static it.unimi.dsi.fastutil.shorts.ShortSpliterator wrap​(short[] array)
    Wraps the given array into a type-specific spliterator.
    static it.unimi.dsi.fastutil.shorts.ShortSpliterator wrap​(short[] array, int offset, int length)
    Wraps the given part of an array into a type-specific spliterator.
    static it.unimi.dsi.fastutil.shorts.ShortSpliterator wrap​(short[] array, int offset, int length, int additionalCharacteristics)
    Wraps the given part of an array into a type-specific spliterator.
    static it.unimi.dsi.fastutil.shorts.ShortSpliterator wrap​(it.unimi.dsi.fastutil.bytes.ByteSpliterator spliterator)
    Returns a spliterator backed by the specified byte spliterator.
    static it.unimi.dsi.fastutil.shorts.ShortSpliterator wrapPreSorted​(short[] array, int offset, int length, int additionalCharacteristics, ShortComparator comparator)
    Wraps the given part of a sorted array into a type-specific spliterator.
    static it.unimi.dsi.fastutil.shorts.ShortSpliterator wrapPreSorted​(short[] array, int offset, int length, ShortComparator comparator)
    Wraps the given part of a sorted array into a type-specific spliterator.
    static it.unimi.dsi.fastutil.shorts.ShortSpliterator wrapPreSorted​(short[] array, ShortComparator comparator)
    Wraps the given sorted array into a type-specific spliterator.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • COLLECTION_SPLITERATOR_CHARACTERISTICS

      public static final int COLLECTION_SPLITERATOR_CHARACTERISTICS
      See Also:
      Constant Field Values

    • LIST_SPLITERATOR_CHARACTERISTICS

      public static final int LIST_SPLITERATOR_CHARACTERISTICS
      See Also:
      Constant Field Values

    • SET_SPLITERATOR_CHARACTERISTICS

      public static final int SET_SPLITERATOR_CHARACTERISTICS
      See Also:
      Constant Field Values

    • SORTED_SET_SPLITERATOR_CHARACTERISTICS

      public static final int SORTED_SET_SPLITERATOR_CHARACTERISTICS
      See Also:
      Constant Field Values

    • EMPTY_SPLITERATOR

      public static final ShortSpliterators.EmptySpliterator EMPTY_SPLITERATOR
      An empty spliterator. It is serializable and cloneable.

      The class of this objects represent an abstract empty spliterator that can iterate as a type-specific spliterator.

  • Method Details

    • singleton

      public static it.unimi.dsi.fastutil.shorts.ShortSpliterator singleton​(short element)
      Returns a spliterator that iterates just over the given element.
      Parameters:
      element - the only element to be returned by a type-specific spliterator.
      Returns:
      a spliterator that iterates just over element.

    • singleton

      public static it.unimi.dsi.fastutil.shorts.ShortSpliterator singleton​(short element, ShortComparator comparator)
      Returns a spliterator that iterates just over the given element.

      The Spliterator.getComparator() method will return the given comparator. This is within spec because sequences of size 1 are trivially sorted for any comparison function.

      Parameters:
      element - the only element to be returned by a type-specific spliterator.
      comparator - the comparator to return when Spliterator.getComparator() is called.
      Returns:
      a spliterator that iterates just over element.

    • wrap

      public static it.unimi.dsi.fastutil.shorts.ShortSpliterator wrap​(short[] array, int offset, int length)
      Wraps the given part of an array into a type-specific spliterator.

      The type-specific spliterator returned by this method will iterate length times, advancing over consecutive elements of the given array starting from the one with index offset.

      The returned spliterator will report characteristics Spliterator.SIZED, Spliterator.SUBSIZED, Spliterator.ORDERED, and for primitive arrays, Spliterator.NONNULL.

      Parameters:
      array - an array to wrap into a type-specific spliterator.
      offset - the first element of the array to be returned.
      length - the number of elements to return.
      Returns:
      a spliterator that will iterate over length elements of array starting at position offset.

    • wrap

      public static it.unimi.dsi.fastutil.shorts.ShortSpliterator wrap​(short[] array)
      Wraps the given array into a type-specific spliterator.

      The type-specific spliterator returned by this method will advance over all elements of the given array.

      The returned spliterator will report characteristics Spliterator.SIZED, Spliterator.SUBSIZED, Spliterator.ORDERED, and for primitive arrays, Spliterator.NONNULL.

      Parameters:
      array - an array to wrap into a type-specific spliterator.
      Returns:
      a spliterator that will iterate over the elements of array.

    • wrap

      public static it.unimi.dsi.fastutil.shorts.ShortSpliterator wrap​(short[] array, int offset, int length, int additionalCharacteristics)
      Wraps the given part of an array into a type-specific spliterator.

      The type-specific spliterator returned by this method will iterate length times, advancing over consecutive elements of the given array starting from the one with index offset.

      The returned spliterator will report characteristics Spliterator.SIZED, Spliterator.SUBSIZED, Spliterator.ORDERED, and for primitive arrays, Spliterator.NONNULL, on top of any additional characteristics given in additionalCharacteristics (for example, if the caller knows the backing array has distinct elements, they can pass Spliterator.DISTINCT).

      Parameters:
      array - an array to wrap into a type-specific spliterator.
      offset - the first element of the array to be returned.
      length - the number of elements to return.
      additionalCharacteristics - any additional characteristics to report.
      Returns:
      a spliterator that will iterate over length elements of array starting at position offset.

    • wrapPreSorted

      public static it.unimi.dsi.fastutil.shorts.ShortSpliterator wrapPreSorted​(short[] array, int offset, int length, int additionalCharacteristics, ShortComparator comparator)
      Wraps the given part of a sorted array into a type-specific spliterator.

      It is the caller's responsibility to ensure the array is actually sorted using the comparator given.

      The type-specific spliterator returned by this method will iterate length times, advancing over consecutive elements of the given array starting from the one with index offset.

      The returned spliterator will report characteristics Spliterator.SIZED, Spliterator.SUBSIZED, Spliterator.ORDERED, Spliterator.SORTED, and for primitive arrays, Spliterator.NONNULL, on top of any additional characteristics given in additionalCharacteristics (for example, if the caller knows the backing array has distinct elements, they can pass Spliterator.DISTINCT).

      Parameters:
      array - an array to wrap into a type-specific spliterator.
      offset - the first element of the array to be returned.
      length - the number of elements to return.
      additionalCharacteristics - any additional characteristics to report.
      comparator - the comparator the array was sorted with (or null for natural ordering)
      Returns:
      a spliterator that will iterate over length elements of array starting at position offset.

    • wrapPreSorted

      public static it.unimi.dsi.fastutil.shorts.ShortSpliterator wrapPreSorted​(short[] array, int offset, int length, ShortComparator comparator)
      Wraps the given part of a sorted array into a type-specific spliterator.

      It is the caller's responsibility to ensure the array is actually sorted using the comparator given.

      The type-specific spliterator returned by this method will iterate length times, advancing over consecutive elements of the given array starting from the one with index offset.

      The returned spliterator will report characteristics Spliterator.SIZED, Spliterator.SUBSIZED, Spliterator.ORDERED, Spliterator.SORTED, and for primitive arrays, Spliterator.NONNULL.

      Parameters:
      array - an array to wrap into a type-specific spliterator.
      offset - the first element of the array to be returned.
      length - the number of elements to return.
      comparator - the comparator the array was sorted with (or null for natural ordering)
      Returns:
      a spliterator that will iterate over length elements of array starting at position offset.

    • wrapPreSorted

      public static it.unimi.dsi.fastutil.shorts.ShortSpliterator wrapPreSorted​(short[] array, ShortComparator comparator)
      Wraps the given sorted array into a type-specific spliterator.

      It is the caller's responsibility to ensure the array is actually sorted using the comparator given.

      The type-specific spliterator returned by this method will advance over all elements of the given array.

      The returned spliterator will report characteristics Spliterator.SIZED, Spliterator.SUBSIZED, Spliterator.ORDERED, Spliterator.SORTED, and for primitive arrays, Spliterator.NONNULL.

      Parameters:
      array - an array to wrap into a type-specific spliterator.
      comparator - the comparator the array was sorted with (or null for natural ordering)
      Returns:
      a spliterator that will iterate over length elements of array starting at position offset.

    • asShortSpliterator

      public static it.unimi.dsi.fastutil.shorts.ShortSpliterator asShortSpliterator​(java.util.Spliterator i)
      Wraps a standard spliterator into a type-specific spliterator.

      This method wraps a standard spliterator into a type-specific one which will handle the type conversions for you. Of course, any attempt to wrap a spliterator returning the instances of the wrong class will generate a ClassCastException. The returned spliterator is backed by i: changes to one of the spliterators will affect the other, too.

      If i is already type-specific, it will returned and no new object will be generated.

      Parameters:
      i - a spliterator.
      Returns:
      a type-specific spliterator backed by i.

    • asShortSpliterator

      public static it.unimi.dsi.fastutil.shorts.ShortSpliterator asShortSpliterator​(java.util.Spliterator i, ShortComparator comparatorOverride)
      Wraps a standard spliterator into a type-specific spliterator.

      This method wraps a standard spliterator into a type-specific one which will handle the type conversions for you. Of course, any attempt to wrap a spliterator returning the instances of the wrong class will generate a ClassCastException. The returned spliterator is backed by i: changes to one of the spliterators will affect the other, too.

      This method will cause the returned spliterator's Spliterator.getComparator() method to always return comparatorOverride, regardless of what the wrapped spliterator's getComparator() method returns.

      NOTE:This is mostly intended for supporting default implementations in interfaces that wrap JDK spliterators, and not a general purpose method.

      If i is already type-specific, this method will throw, as such spliterators already have a getComparator() that returns a properly typed comparator.

      Parameters:
      i - a spliterator.
      comparatorOverride - the comparator to return when Spliterator.getComparator()
      Returns:
      a type-specific spliterator backed by i.

    • narrow

      public static it.unimi.dsi.fastutil.shorts.ShortSpliterator narrow​(java.util.Spliterator.OfInt i)
      Wrap a JDK primitive spliterator to a type-specific spliterator, making checked narrowed casts.

      The tryAdvance method throws IllegalArgumentException if any element would underflow or overflow.

      Parameters:
      i - a spiterator
      Returns:
      a type-specific spliterator backed by i

    • widen

      public static it.unimi.dsi.fastutil.ints.IntSpliterator widen​(it.unimi.dsi.fastutil.shorts.ShortSpliterator i)
      Wrap a type-specific spliterator to a JDK compatible primitive spliterator.
      Parameters:
      i - a spliterator
      Returns:
      a JDK compatible primitive spliterator backed by i

    • onEachMatching

      public static void onEachMatching​(it.unimi.dsi.fastutil.shorts.ShortSpliterator spliterator, ShortPredicate predicate, ShortConsumer action)
      Perform the given action on each element that matches the given predicate.

      This is equivalent to java.util.stream.StreamSupport.stream(spliterator).filter(predicate).forEach(action) (substitute the proper primitive stream as needed), except it may perform better (but no potential for parallelism).

    • onEachMatching

      public static void onEachMatching​(it.unimi.dsi.fastutil.shorts.ShortSpliterator spliterator, java.util.function.IntPredicate predicate, java.util.function.IntConsumer action)
      Perform the given action on each element that matches the given predicate.

      This is equivalent to java.util.stream.StreamSupport.stream(spliterator).filter(predicate).forEach(action) (substitute the proper primitive stream as needed), except it may perform better (but no potential for parallelism).

    • fromTo

      public static it.unimi.dsi.fastutil.shorts.ShortSpliterator fromTo​(short from, short to)
      Creates a type-specific spliterator over an interval.

      The type-specific spliterator returned by this method will return the elements from, from+1,…, to-1.

      Parameters:
      from - the starting element (inclusive).
      to - the ending element (exclusive).
      Returns:
      a type-specific spliterator enumerating the elements from from to to.

    • concat

      public static it.unimi.dsi.fastutil.shorts.ShortSpliterator concat​(it.unimi.dsi.fastutil.shorts.ShortSpliterator... a)
      Concatenates all spliterators contained in an array.

      This method returns a spliterator that will enumerate in order the elements returned by all spliterators contained in the given array.

      Note: Due to there being no way to ensure the Comparator is consistent between each inner spliterator, the returned spliterator's Spliterator.getComparator() will always throw IllegalStateException, even when if the current or even all the inner spliterators are sorted.

      Parameters:
      a - an array of spliterators.
      Returns:
      a spliterator obtained by concatenation.

    • concat

      public static it.unimi.dsi.fastutil.shorts.ShortSpliterator concat​(it.unimi.dsi.fastutil.shorts.ShortSpliterator[] a, int offset, int length)
      Concatenates a sequence of spliterators contained in an array.

      This method returns a spliterator that will enumerate in order the elements returned by a[offset], then those returned by a[offset + 1], and so on up to a[offset + length - 1].

      Note: Due to there being no way to ensure the Comparator is consistent between each inner spliterator, the returned spliterator's Spliterator.getComparator() will always throw IllegalStateException, even when if the current or even all the inner spliterators are sorted.

      Parameters:
      a - an array of spliterators.
      offset - the index of the first spliterator to concatenate.
      length - the number of spliterators to concatenate.
      Returns:
      a spliterator obtained by concatenation of length elements of a starting at offset.

    • asSpliterator

      public static it.unimi.dsi.fastutil.shorts.ShortSpliterator asSpliterator​(it.unimi.dsi.fastutil.shorts.ShortIterator iter, long size, int additionalCharacterisitcs)
      Wrap a type-specific Iterator of a known size as a type-specific Spliterator

      The returned spliterator will report characteristics additionalCharacterisitcs, and for primitive types, Spliterator.NONNULL. It will also report Spliterator.SIZED, Spliterator.SUBSIZED, unless Spliterator.CONCURRENT is to be reported, in which case these two are not implicitly reported.

      Because Iterator is an inherently linear API, the returned spliterator will yield limited performance gains when run in parallel contexts, as the returned spliterator's Spliterator.trySplit() will have linear runtime.

      Parameters:
      iter - the type-specific Iterator to wrap
      size - the number of elements the iterator will return
      additionalCharacterisitcs - any additional characteristics to report
      Returns:
      a type-specific Spliterator that will give the same elements the iterator will return.
      See Also:
      Spliterators.spliterator(java.util.Iterator, long, int)

    • asSpliteratorFromSorted

      public static it.unimi.dsi.fastutil.shorts.ShortSpliterator asSpliteratorFromSorted​(it.unimi.dsi.fastutil.shorts.ShortIterator iter, long size, int additionalCharacterisitcs, ShortComparator comparator)
      Wrap a type-specific, sorted Iterator of a known size as a type-specific Spliterator

      It is the caller's responsibility to ensure the iterator's order is actually sorted according to the comparator given.

      The returned spliterator will report characteristics additionalCharacterisitcs, Spliterator.ORDERED, Spliterator.SORTED, and for primitive types, Spliterator.NONNULL. It will also report Spliterator.SIZED, Spliterator.SUBSIZED, unless Spliterator.CONCURRENT is to be reported, in which case these two are not implicitly reported.

      Because Iterator is an inherently linear API, the returned spliterator will yield limited performance gains when run in parallel contexts, as the returned spliterator's Spliterator.trySplit() will have linear runtime.

      Parameters:
      iter - the type-specific Iterator to wrap
      size - the number of elements the iterator will return
      additionalCharacterisitcs - any additional characteristics to report
      comparator - the comparator the iterator is ordered on (or null for natural ordering)
      Returns:
      a type-specific Spliterator that will give the same elements the iterator will return.

    • asSpliteratorUnknownSize

      public static it.unimi.dsi.fastutil.shorts.ShortSpliterator asSpliteratorUnknownSize​(it.unimi.dsi.fastutil.shorts.ShortIterator iter, int characterisitcs)
      Wrap a type-specific Iterator of an unknown size as a type-specific Spliterator

      The returned spliterator will report additionalCharacterisitcs, and for primitive types, Spliterator.NONNULL.

      Because Iterator is an inherently linear API, the returned spliterator will yield limited performance gains when run in parallel contexts, as the returned spliterator's Spliterator.trySplit() will have linear runtime.

      Parameters:
      iter - the type-specific Iterator to wrap
      characterisitcs - the characteristics to report
      Returns:
      a type-specific Spliterator that will give the same elements the iterator will return.
      See Also:
      Spliterators.spliteratorUnknownSize(java.util.Iterator, int)

    • asSpliteratorFromSortedUnknownSize

      public static it.unimi.dsi.fastutil.shorts.ShortSpliterator asSpliteratorFromSortedUnknownSize​(it.unimi.dsi.fastutil.shorts.ShortIterator iter, int additionalCharacterisitcs, ShortComparator comparator)
      Wrap a type-specific, sorted Iterator of an unknown size as a type-specific Spliterator

      It is the caller's responsibility to ensure the iterator's order is actually sorted according to the comparator given.

      The returned spliterator will report characteristics additionalCharacterisitcs, Spliterator.ORDERED, Spliterator.SORTED, and for primitive types, Spliterator.NONNULL.

      Because Iterator is an inherently linear API, the returned spliterator will yield limited performance gains when run in parallel contexts, as the returned spliterator's Spliterator.trySplit() will have linear runtime.

      Parameters:
      iter - the type-specific Iterator to wrap
      additionalCharacterisitcs - the characteristics to report
      comparator - the comparator the iterator is ordered on (or null for natural ordering)
      Returns:
      a type-specific Spliterator that will give the same elements the iterator will return.

    • asIterator

      public static it.unimi.dsi.fastutil.shorts.ShortIterator asIterator​(it.unimi.dsi.fastutil.shorts.ShortSpliterator spliterator)
      Wrap a type-specific Spliterator as a type-specific Iterator
      Parameters:
      spliterator - the type-specific Spliterator to wrap
      Returns:
      a type-specific Iterator that will return the same elements the spliterator will give.
      See Also:
      Spliterators.iterator(java.util.Spliterator)

    • wrap

      public static it.unimi.dsi.fastutil.shorts.ShortSpliterator wrap​(it.unimi.dsi.fastutil.bytes.ByteSpliterator spliterator)
      Returns a spliterator backed by the specified byte spliterator.

      Note: Due to the incompatibility of primitive Comparator types, the returned spliterator's Spliterator.getComparator() will always throw IllegalStateException, even when the underlying spliterator is sorted.

      Parameters:
      spliterator - a byte spliterator.
      Returns:
      a spliterator backed by the specified byte spliterator.