ShortIterators (Primitive-Collections 0.7.0 API)

java.lang.Object
- speiger.src.collections.shorts.utils.ShortIterators

public class ShortIterators
extends java.lang.Object

A Helper class for Iterators

Constructor Summary

Constructors
Constructor and Description

ShortIterators()

Constructors
Constructor and Description
`ShortIterators()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <E> ObjectIterator<E>`	`arrayFlatMap(java.util.Iterator<? extends java.lang.Short> iterator, Short2ObjectFunction<E[]> mapper)` A Helper function that flatMaps a Java-Iterator into a new Type.
`static <E> ObjectIterator<E>`	`arrayFlatMap(ShortIterator iterator, Short2ObjectFunction<E[]> mapper)` A Helper function that flatMaps a Iterator into a new Type.
`static ShortIterator`	`concat(ShortIterator... array)` Helper Iterator that concats other iterators together
`static ShortIterator`	`concat(ShortIterator[] array, int offset, int length)` Helper Iterator that concats other iterators together
`static ShortIterator`	`distinct(java.util.Iterator<? extends java.lang.Short> iterator)` A Helper function that filters out all duplicated elements from a Java Iterator.
`static ShortIterator`	`distinct(ShortIterator iterator)` A Helper function that filters out all duplicated elements.
`static speiger.src.collections.shorts.utils.ShortIterators.EmptyIterator`	`empty()` Returns a Immutable EmptyIterator instance that is automatically casted.
`static ShortIterator`	`filter(java.util.Iterator<? extends java.lang.Short> iterator, Short2BooleanFunction filter)` A Helper function that filters out all desired elements from a Java-Iterator
`static ShortIterator`	`filter(ShortIterator iterator, Short2BooleanFunction filter)` A Helper function that filters out all desired elements
`static <E,V extends java.lang.Iterable<E>> ObjectIterator<E>`	`flatMap(java.util.Iterator<? extends java.lang.Short> iterator, Short2ObjectFunction<V> mapper)` A Helper function that flatMaps a Java-Iterator into a new Type.
`static <E,V extends java.lang.Iterable<E>> ObjectIterator<E>`	`flatMap(ShortIterator iterator, Short2ObjectFunction<V> mapper)` A Helper function that flatMaps a Iterator into a new Type.
`static ShortBidirectionalIterator`	`invert(ShortBidirectionalIterator it)` Inverter function for Bidirectional Iterators
`static ShortListIterator`	`invert(ShortListIterator it)` Inverter function for List Iterators
`static ShortIterator`	`limit(java.util.Iterator<? extends java.lang.Short> iterator, long limit)` A Helper function that hard limits the Iterator to a specific size from a Java Iterator
`static ShortIterator`	`limit(ShortIterator iterator, long limit)` A Helper function that hard limits the Iterator to a specific size
`static <E> ObjectIterator<E>`	`map(java.util.Iterator<? extends java.lang.Short> iterator, Short2ObjectFunction<E> mapper)` A Helper function that maps a Java-Iterator into a new Type.
`static <E> ObjectIterator<E>`	`map(ShortIterator iterator, Short2ObjectFunction<E> mapper)` A Helper function that maps a Iterator into a new Type.
`static ShortIterator`	`peek(java.util.Iterator<? extends java.lang.Short> iterator, ShortConsumer action)` A Helper function that allows to preview the result of a Iterator from a Java Iterator
`static ShortIterator`	`peek(ShortIterator iterator, ShortConsumer action)` A Helper function that allows to preview the result of a Iterator.
`static ShortList`	`pour(ShortIterator iter)` A Helper function to pours all elements of a Iterator into a List
`static ShortList`	`pour(ShortIterator iter, int max)` A Helper function to pours all elements of a Iterator into a List
`static int`	`pour(ShortIterator iter, ShortCollection c)` A Helper function to pours all elements of a Iterator into a Collection
`static int`	`pour(ShortIterator iter, ShortCollection c, int max)` A Helper function to pours all elements of a Iterator into a Collection
`static ShortIterator`	`sorted(java.util.Iterator<? extends java.lang.Short> iterator, ShortComparator sorter)` A Helper function that sorts the Iterator beforehand from a Java Iterator.
`static ShortIterator`	`sorted(ShortIterator iterator, ShortComparator sorter)` A Helper function that sorts the Iterator beforehand.
`static ShortBidirectionalIterator`	`unmodifiable(ShortBidirectionalIterator iterator)` Returns a Immutable Iterator instance based on the instance given.
`static ShortIterator`	`unmodifiable(ShortIterator iterator)` Returns a Immutable Iterator instance based on the instance given.
`static ShortListIterator`	`unmodifiable(ShortListIterator iterator)` Returns a Immutable ListIterator instance based on the instance given.
`static int`	`unwrap(short[] a, java.util.Iterator<? extends java.lang.Short> i)` Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
`static int`	`unwrap(short[] a, java.util.Iterator<? extends java.lang.Short> i, int offset)` Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
`static int`	`unwrap(short[] a, java.util.Iterator<? extends java.lang.Short> i, int offset, int max)` Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
`static int`	`unwrap(short[] a, ShortIterator i)` A Primitive iterator variant of the ShortIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
`static int`	`unwrap(java.lang.Short[] a, ShortIterator i)` A Function to convert a Primitive Iterator to a Object array.
`static int`	`unwrap(short[] a, ShortIterator i, int offset)` A Primitive iterator variant of the ShortIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
`static int`	`unwrap(java.lang.Short[] a, ShortIterator i, int offset)` A Function to convert a Primitive Iterator to a Object array.
`static int`	`unwrap(short[] a, ShortIterator i, int offset, int max)` A Primitive iterator variant of the ShortIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
`static int`	`unwrap(java.lang.Short[] a, ShortIterator i, int offset, int max)` A Function to convert a Primitive Iterator to a Object array.
`static ShortIterator`	`wrap(java.util.Iterator<? extends java.lang.Short> iterator)` Helper function to convert a Object Iterator into a Primitive Iterator
`static speiger.src.collections.shorts.utils.ShortIterators.ArrayIterator`	`wrap(short... a)` Returns a Array Wrapping iterator
`static speiger.src.collections.shorts.utils.ShortIterators.ArrayIterator`	`wrap(short[] a, int start, int end)` Returns a Array Wrapping iterator

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ShortIterators
```
public ShortIterators()
```
- Method Detail
  - empty
```
public static speiger.src.collections.shorts.utils.ShortIterators.EmptyIterator empty()
```
    Returns a Immutable EmptyIterator instance that is automatically casted.
    
    Returns:
    
    an empty iterator
  - invert
```
public static ShortBidirectionalIterator invert(ShortBidirectionalIterator it)
```
    Inverter function for Bidirectional Iterators
    
    Parameters:
    
    it - the iterator that should be inverted
    
    Returns:
    
    a Inverted Bidirectional Iterator. If it was inverted then it just gives back the original reference
  - invert
```
public static ShortListIterator invert(ShortListIterator it)
```
    Inverter function for List Iterators
    
    Parameters:
    
    it - the iterator that should be inverted
    
    Returns:
    
    a Inverted List Iterator. If it was inverted then it just gives back the original reference
  - unmodifiable
```
public static ShortIterator unmodifiable(ShortIterator iterator)
```
    Returns a Immutable Iterator instance based on the instance given.
    
    Parameters:
    
    iterator - that should be made immutable/unmodifiable
    
    Returns:
    
    a unmodifiable iterator wrapper. If the Iterator already a unmodifiable wrapper then it just returns itself.
  - unmodifiable
```
public static ShortBidirectionalIterator unmodifiable(ShortBidirectionalIterator iterator)
```
    Returns a Immutable Iterator instance based on the instance given.
    
    Parameters:
    
    iterator - that should be made immutable/unmodifiable
    
    Returns:
    
    a unmodifiable iterator wrapper. If the Iterator already a unmodifiable wrapper then it just returns itself.
  - unmodifiable
```
public static ShortListIterator unmodifiable(ShortListIterator iterator)
```
    Returns a Immutable ListIterator instance based on the instance given.
    
    Parameters:
    
    iterator - that should be made immutable/unmodifiable
    
    Returns:
    
    a unmodifiable listiterator wrapper. If the ListIterator already a unmodifiable wrapper then it just returns itself.
  - map
```
public static <E> ObjectIterator<E> map(java.util.Iterator<? extends java.lang.Short> iterator,
                                        Short2ObjectFunction<E> mapper)
```
    A Helper function that maps a Java-Iterator into a new Type.
    
    Type Parameters:
    
    E - The return type.
    
    Parameters:
    
    iterator - that should be mapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterator that is mapped to a new result
  - map
```
public static <E> ObjectIterator<E> map(ShortIterator iterator,
                                        Short2ObjectFunction<E> mapper)
```
    A Helper function that maps a Iterator into a new Type.
    
    Type Parameters:
    
    E - The return type.
    
    Parameters:
    
    iterator - that should be mapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterator that is mapped to a new result
  - flatMap
```
public static <E,V extends java.lang.Iterable<E>> ObjectIterator<E> flatMap(java.util.Iterator<? extends java.lang.Short> iterator,
                                                                            Short2ObjectFunction<V> mapper)
```
    A Helper function that flatMaps a Java-Iterator into a new Type.
    
    Type Parameters:
    
    V - The return type supplier.
    
    E - The return type.
    
    Parameters:
    
    iterator - that should be flatMapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterator that is flatMapped to a new result
  - flatMap
```
public static <E,V extends java.lang.Iterable<E>> ObjectIterator<E> flatMap(ShortIterator iterator,
                                                                            Short2ObjectFunction<V> mapper)
```
    A Helper function that flatMaps a Iterator into a new Type.
    
    Type Parameters:
    
    V - The return type supplier.
    
    E - The return type.
    
    Parameters:
    
    iterator - that should be flatMapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterator that is flatMapped to a new result
  - arrayFlatMap
```
public static <E> ObjectIterator<E> arrayFlatMap(java.util.Iterator<? extends java.lang.Short> iterator,
                                                 Short2ObjectFunction<E[]> mapper)
```
    A Helper function that flatMaps a Java-Iterator into a new Type.
    
    Type Parameters:
    
    E - The return type.
    
    Parameters:
    
    iterator - that should be flatMapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterator that is flatMapped to a new result
  - arrayFlatMap
```
public static <E> ObjectIterator<E> arrayFlatMap(ShortIterator iterator,
                                                 Short2ObjectFunction<E[]> mapper)
```
    A Helper function that flatMaps a Iterator into a new Type.
    
    Type Parameters:
    
    E - The return type.
    
    Parameters:
    
    iterator - that should be flatMapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterator that is flatMapped to a new result
  - filter
```
public static ShortIterator filter(java.util.Iterator<? extends java.lang.Short> iterator,
                                   Short2BooleanFunction filter)
```
    A Helper function that filters out all desired elements from a Java-Iterator
    
    Parameters:
    
    iterator - that should be filtered.
    
    filter - the filter that decides that should be let through
    
    Returns:
    
    a filtered iterator
  - filter
```
public static ShortIterator filter(ShortIterator iterator,
                                   Short2BooleanFunction filter)
```
    A Helper function that filters out all desired elements
    
    Parameters:
    
    iterator - that should be filtered.
    
    filter - the filter that decides that should be let through
    
    Returns:
    
    a filtered iterator
  - distinct
```
public static ShortIterator distinct(ShortIterator iterator)
```
    A Helper function that filters out all duplicated elements.
    
    Parameters:
    
    iterator - that should be distinct
    
    Returns:
    
    a distinct iterator
  - distinct
```
public static ShortIterator distinct(java.util.Iterator<? extends java.lang.Short> iterator)
```
    A Helper function that filters out all duplicated elements from a Java Iterator.
    
    Parameters:
    
    iterator - that should be distinct
    
    Returns:
    
    a distinct iterator
  - limit
```
public static ShortIterator limit(ShortIterator iterator,
                                  long limit)
```
    A Helper function that hard limits the Iterator to a specific size
    
    Parameters:
    
    iterator - that should be limited
    
    limit - the amount of elements it should be limited to
    
    Returns:
    
    a limited iterator
  - limit
```
public static ShortIterator limit(java.util.Iterator<? extends java.lang.Short> iterator,
                                  long limit)
```
    A Helper function that hard limits the Iterator to a specific size from a Java Iterator
    
    Parameters:
    
    iterator - that should be limited
    
    limit - the amount of elements it should be limited to
    
    Returns:
    
    a limited iterator
  - sorted
```
public static ShortIterator sorted(ShortIterator iterator,
                                   ShortComparator sorter)
```
    A Helper function that sorts the Iterator beforehand. This operation is heavily hurting performance because it rebuilds the entire iterator and then sorts it.
    
    Parameters:
    
    iterator - that should be sorted.
    
    sorter - the sorter of the iterator. Can be null.
    
    Returns:
    
    a new sorted iterator
  - sorted
```
public static ShortIterator sorted(java.util.Iterator<? extends java.lang.Short> iterator,
                                   ShortComparator sorter)
```
    A Helper function that sorts the Iterator beforehand from a Java Iterator. This operation is heavily hurting performance because it rebuilds the entire iterator and then sorts it.
    
    Parameters:
    
    iterator - that should be sorted.
    
    sorter - the sorter of the iterator. Can be null.
    
    Returns:
    
    a new sorted iterator
  - peek
```
public static ShortIterator peek(ShortIterator iterator,
                                 ShortConsumer action)
```
    A Helper function that allows to preview the result of a Iterator.
    
    Parameters:
    
    iterator - that should be peeked at
    
    action - callback that receives the value before the iterator returns it
    
    Returns:
    
    a peeked iterator
  - peek
```
public static ShortIterator peek(java.util.Iterator<? extends java.lang.Short> iterator,
                                 ShortConsumer action)
```
    A Helper function that allows to preview the result of a Iterator from a Java Iterator
    
    Parameters:
    
    iterator - that should be peeked at
    
    action - callback that receives the value before the iterator returns it
    
    Returns:
    
    a peeked iterator
  - wrap
```
public static ShortIterator wrap(java.util.Iterator<? extends java.lang.Short> iterator)
```
    Helper function to convert a Object Iterator into a Primitive Iterator
    
    Parameters:
    
    iterator - that should be converted to a unboxing iterator
    
    Returns:
    
    a primitive iterator
  - wrap
```
public static speiger.src.collections.shorts.utils.ShortIterators.ArrayIterator wrap(short... a)
```
    Returns a Array Wrapping iterator
    
    Parameters:
    
    a - the array that should be wrapped
    
    Returns:
    
    a Iterator that is wrapping a array.
  - wrap
```
public static speiger.src.collections.shorts.utils.ShortIterators.ArrayIterator wrap(short[] a,
                                                                                     int start,
                                                                                     int end)
```
    Returns a Array Wrapping iterator
    
    Parameters:
    
    a - the array that should be wrapped.
    
    start - the index to be started from.
    
    end - the index that should be ended.
    
    Returns:
    
    a Iterator that is wrapping a array.
  - unwrap
```
public static int unwrap(short[] a,
                         java.util.Iterator<? extends java.lang.Short> i)
```
    Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Parameters:
    
    a - where the elements should be inserted
    
    i - the source iterator
    
    Returns:
    
    the amount of elements that were inserted into the array.
  - unwrap
```
public static int unwrap(short[] a,
                         java.util.Iterator<? extends java.lang.Short> i,
                         int offset)
```
    Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Parameters:
    
    a - where the elements should be inserted
    
    i - the source iterator
    
    offset - the array offset where the start should be
    
    Returns:
    
    the amount of elements that were inserted into the array.
  - unwrap
```
public static int unwrap(short[] a,
                         java.util.Iterator<? extends java.lang.Short> i,
                         int offset,
                         int max)
```
    Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Parameters:
    
    a - where the elements should be inserted
    
    i - the source iterator
    
    offset - the array offset where the start should be
    
    max - the maximum values that should be extracted from the source
    
    Returns:
    
    the amount of elements that were inserted into the array.
    
    Throws:
    
    java.lang.IllegalStateException - if max is smaller the 0 or if the maximum index is larger then the array
  - unwrap
```
public static int unwrap(short[] a,
                         ShortIterator i)
```
    A Primitive iterator variant of the ShortIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Parameters:
    
    a - where the elements should be inserted
    
    i - the source iterator
    
    Returns:
    
    the amount of elements that were inserted into the array.
  - unwrap
```
public static int unwrap(short[] a,
                         ShortIterator i,
                         int offset)
```
    A Primitive iterator variant of the ShortIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Parameters:
    
    a - where the elements should be inserted
    
    i - the source iterator
    
    offset - the array offset where the start should be
    
    Returns:
    
    the amount of elements that were inserted into the array.
  - unwrap
```
public static int unwrap(short[] a,
                         ShortIterator i,
                         int offset,
                         int max)
```
    A Primitive iterator variant of the ShortIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Parameters:
    
    a - where the elements should be inserted
    
    i - the source iterator
    
    offset - the array offset where the start should be
    
    max - the maximum values that should be extracted from the source
    
    Returns:
    
    the amount of elements that were inserted into the array.
    
    Throws:
    
    java.lang.IllegalStateException - if max is smaller the 0 or if the maximum index is larger then the array
  - unwrap
```
public static int unwrap(java.lang.Short[] a,
                         ShortIterator i)
```
    A Function to convert a Primitive Iterator to a Object array. Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Parameters:
    
    a - where the elements should be inserted
    
    i - the source iterator
    
    Returns:
    
    the amount of elements that were inserted into the array.
  - unwrap
```
public static int unwrap(java.lang.Short[] a,
                         ShortIterator i,
                         int offset)
```
    A Function to convert a Primitive Iterator to a Object array. Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Parameters:
    
    a - where the elements should be inserted
    
    i - the source iterator
    
    offset - the array offset where the start should be
    
    Returns:
    
    the amount of elements that were inserted into the array.
  - unwrap
```
public static int unwrap(java.lang.Short[] a,
                         ShortIterator i,
                         int offset,
                         int max)
```
    A Function to convert a Primitive Iterator to a Object array. Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Parameters:
    
    a - where the elements should be inserted
    
    i - the source iterator
    
    offset - the array offset where the start should be
    
    max - the maximum values that should be extracted from the source
    
    Returns:
    
    the amount of elements that were inserted into the array.
    
    Throws:
    
    java.lang.IllegalStateException - if max is smaller the 0 or if the maximum index is larger then the array
  - pour
```
public static ShortList pour(ShortIterator iter)
```
    A Helper function to pours all elements of a Iterator into a List
    
    Parameters:
    
    iter - the elements that should be poured into list.
    
    Returns:
    
    A list of all elements of the Iterator
  - pour
```
public static ShortList pour(ShortIterator iter,
                             int max)
```
    A Helper function to pours all elements of a Iterator into a List
    
    Parameters:
    
    iter - the elements that should be poured into list.
    
    max - the maximum amount of elements that should be collected
    
    Returns:
    
    A list of all requested elements of the Iterator
  - pour
```
public static int pour(ShortIterator iter,
                       ShortCollection c)
```
    A Helper function to pours all elements of a Iterator into a Collection
    
    Parameters:
    
    iter - the elements that should be poured into list.
    
    c - the collection where the elements should be poured into
    
    Returns:
    
    the amount of elements that were added
  - pour
```
public static int pour(ShortIterator iter,
                       ShortCollection c,
                       int max)
```
    A Helper function to pours all elements of a Iterator into a Collection
    
    Parameters:
    
    iter - the elements that should be poured into list.
    
    c - the collection where the elements should be poured into
    
    max - the maximum amount of elements that should be collected
    
    Returns:
    
    the amount of elements that were added
  - concat
```
public static ShortIterator concat(ShortIterator... array)
```
    Helper Iterator that concats other iterators together
    
    Parameters:
    
    array - the Iterators that should be concatenated
    
    Returns:
    
    iterator of the inputted iterators
  - concat
```
public static ShortIterator concat(ShortIterator[] array,
                                   int offset,
                                   int length)
```
    Helper Iterator that concats other iterators together
    
    Parameters:
    
    array - the Iterators that should be concatenated
    
    offset - where to start within the array
    
    length - the length of the array
    
    Returns:
    
    iterator of the inputted iterators

Class ShortIterators

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ShortIterators

Method Detail

empty

invert

invert

unmodifiable

unmodifiable

unmodifiable

map

map

flatMap

flatMap

arrayFlatMap

arrayFlatMap

filter

filter

distinct

distinct

limit

limit

sorted

sorted

peek

peek

wrap

wrap

wrap

unwrap

unwrap

unwrap

unwrap

unwrap

unwrap

unwrap

unwrap

unwrap

pour

pour

pour

pour

concat

concat