IntIterables (Primitive-Collections 0.7.0 API)

java.lang.Object
- speiger.src.collections.ints.utils.IntIterables

public class IntIterables
extends java.lang.Object

A Helper class for Iterables

Constructor Summary

Constructors
Constructor and Description

IntIterables()

Constructors
Constructor and Description
`IntIterables()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <E> ObjectIterable<E>`	`arrayFlatMap(IntIterable iterable, Int2ObjectFunction<E[]> mapper)` A Helper function that flatMaps a Iterable into a new Type.
`static <E> ObjectIterable<E>`	`arrayFlatMap(java.lang.Iterable<? extends java.lang.Integer> iterable, Int2ObjectFunction<E[]> mapper)` A Helper function that flatMaps a Java-Iterable into a new Type.
`static IntIterable`	`distinct(IntIterable iterable)` A Helper function that filters out all duplicated elements.
`static IntIterable`	`distinct(java.lang.Iterable<? extends java.lang.Integer> iterable)` A Helper function that filters out all duplicated elements from a Java Iterable.
`static IntIterable`	`filter(IntIterable iterable, Int2BooleanFunction filter)` A Helper function that filters out all desired elements
`static IntIterable`	`filter(java.lang.Iterable<? extends java.lang.Integer> iterable, Int2BooleanFunction filter)` A Helper function that filters out all desired elements from a Java-Iterable
`static <E,V extends java.lang.Iterable<E>> ObjectIterable<E>`	`flatMap(IntIterable iterable, Int2ObjectFunction<V> mapper)` A Helper function that flatMaps a Iterable into a new Type.
`static <E,V extends java.lang.Iterable<E>> ObjectIterable<E>`	`flatMap(java.lang.Iterable<? extends java.lang.Integer> iterable, Int2ObjectFunction<V> mapper)` A Helper function that flatMaps a Java-Iterable into a new Type.
`static IntIterable`	`limit(IntIterable iterable, long limit)` A Helper function that hard limits the Iterable to a specific size
`static IntIterable`	`limit(java.lang.Iterable<? extends java.lang.Integer> iterable, long limit)` A Helper function that hard limits the Iterable to a specific size from a Java Iterable
`static <E> ObjectIterable<E>`	`map(IntIterable iterable, Int2ObjectFunction<E> mapper)` A Helper function that maps a Iterable into a new Type.
`static <E> ObjectIterable<E>`	`map(java.lang.Iterable<? extends java.lang.Integer> iterable, Int2ObjectFunction<E> mapper)` A Helper function that maps a Java-Iterable into a new Type.
`static IntIterable`	`peek(IntIterable iterable, IntConsumer action)` A Helper function that allows to preview the result of a Iterable.
`static IntIterable`	`peek(java.lang.Iterable<? extends java.lang.Integer> iterable, IntConsumer action)` A Helper function that allows to preview the result of a Iterable from a Java Iterable
`static IntIterable`	`sorted(IntIterable iterable, IntComparator sorter)` A Helper function that sorts the Iterable.
`static IntIterable`	`sorted(java.lang.Iterable<? extends java.lang.Integer> iterable, IntComparator sorter)` A Helper function that sorts the Iterable from a Java Iterable This operation is heavily hurting performance because it rebuilds the entire iterator and then sorts it.
`static IntIterable`	`wrap(java.lang.Iterable<? extends java.lang.Integer> iterable)` A Wrapper function that wraps a Java-Iterable into a Type Specific Iterable

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

- Constructor Detail
  - IntIterables
```
public IntIterables()
```
- Method Detail
  - map
```
public static <E> ObjectIterable<E> map(java.lang.Iterable<? extends java.lang.Integer> iterable,
                                        Int2ObjectFunction<E> mapper)
```
    A Helper function that maps a Java-Iterable into a new Type.
    
    Type Parameters:
    
    E - The return type.
    
    Parameters:
    
    iterable - the iterable that should be mapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterable that is mapped to a new result
  - map
```
public static <E> ObjectIterable<E> map(IntIterable iterable,
                                        Int2ObjectFunction<E> mapper)
```
    A Helper function that maps a Iterable into a new Type.
    
    Type Parameters:
    
    E - The return type.
    
    Parameters:
    
    iterable - the iterable that should be mapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterable that is mapped to a new result
  - flatMap
```
public static <E,V extends java.lang.Iterable<E>> ObjectIterable<E> flatMap(java.lang.Iterable<? extends java.lang.Integer> iterable,
                                                                            Int2ObjectFunction<V> mapper)
```
    A Helper function that flatMaps a Java-Iterable into a new Type.
    
    Type Parameters:
    
    V - The return type supplier.
    
    E - The return type.
    
    Parameters:
    
    iterable - the iterable that should be flatMapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterable that is flatMapped to a new result
  - flatMap
```
public static <E,V extends java.lang.Iterable<E>> ObjectIterable<E> flatMap(IntIterable iterable,
                                                                            Int2ObjectFunction<V> mapper)
```
    A Helper function that flatMaps a Iterable into a new Type.
    
    Type Parameters:
    
    V - The return type supplier.
    
    E - The return type.
    
    Parameters:
    
    iterable - the iterable that should be flatMapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterable that is flatMapped to a new result
  - arrayFlatMap
```
public static <E> ObjectIterable<E> arrayFlatMap(java.lang.Iterable<? extends java.lang.Integer> iterable,
                                                 Int2ObjectFunction<E[]> mapper)
```
    A Helper function that flatMaps a Java-Iterable into a new Type.
    
    Type Parameters:
    
    E - The return type.
    
    Parameters:
    
    iterable - the iterable that should be flatMapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterable that is flatMapped to a new result
  - arrayFlatMap
```
public static <E> ObjectIterable<E> arrayFlatMap(IntIterable iterable,
                                                 Int2ObjectFunction<E[]> mapper)
```
    A Helper function that flatMaps a Iterable into a new Type.
    
    Type Parameters:
    
    E - The return type.
    
    Parameters:
    
    iterable - the iterable that should be flatMapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterable that is flatMapped to a new result
  - filter
```
public static IntIterable filter(java.lang.Iterable<? extends java.lang.Integer> iterable,
                                 Int2BooleanFunction filter)
```
    A Helper function that filters out all desired elements from a Java-Iterable
    
    Parameters:
    
    iterable - that should be filtered.
    
    filter - the filter that decides that should be let through
    
    Returns:
    
    a filtered iterable
  - filter
```
public static IntIterable filter(IntIterable iterable,
                                 Int2BooleanFunction filter)
```
    A Helper function that filters out all desired elements
    
    Parameters:
    
    iterable - that should be filtered.
    
    filter - the filter that decides that should be let through
    
    Returns:
    
    a filtered iterable
  - distinct
```
public static IntIterable distinct(IntIterable iterable)
```
    A Helper function that filters out all duplicated elements.
    
    Parameters:
    
    iterable - that should be distinct
    
    Returns:
    
    a distinct iterable
  - distinct
```
public static IntIterable distinct(java.lang.Iterable<? extends java.lang.Integer> iterable)
```
    A Helper function that filters out all duplicated elements from a Java Iterable.
    
    Parameters:
    
    iterable - that should be distinct
    
    Returns:
    
    a distinct iterable
  - limit
```
public static IntIterable limit(IntIterable iterable,
                                long limit)
```
    A Helper function that hard limits the Iterable to a specific size
    
    Parameters:
    
    iterable - that should be limited
    
    limit - the amount of elements it should be limited to
    
    Returns:
    
    a limited iterable
  - limit
```
public static IntIterable limit(java.lang.Iterable<? extends java.lang.Integer> iterable,
                                long limit)
```
    A Helper function that hard limits the Iterable to a specific size from a Java Iterable
    
    Parameters:
    
    iterable - that should be limited
    
    limit - the amount of elements it should be limited to
    
    Returns:
    
    a limited iterable
  - sorted
```
public static IntIterable sorted(IntIterable iterable,
                                 IntComparator sorter)
```
    A Helper function that sorts the Iterable. This operation is heavily hurting performance because it rebuilds the entire iterator and then sorts it.
    
    Parameters:
    
    iterable - that should be sorted
    
    sorter - that sorts the iterable. Can be null.
    
    Returns:
    
    a sorted iterable.
  - sorted
```
public static IntIterable sorted(java.lang.Iterable<? extends java.lang.Integer> iterable,
                                 IntComparator sorter)
```
    A Helper function that sorts the Iterable from a Java Iterable This operation is heavily hurting performance because it rebuilds the entire iterator and then sorts it.
    
    Parameters:
    
    iterable - that should be sorted
    
    sorter - that sorts the iterable. Can be null.
    
    Returns:
    
    a sorted iterable.
  - peek
```
public static IntIterable peek(IntIterable iterable,
                               IntConsumer action)
```
    A Helper function that allows to preview the result of a Iterable.
    
    Parameters:
    
    iterable - that should be peeked at
    
    action - callback that receives the value before the iterable returns it
    
    Returns:
    
    a peeked iterable
  - peek
```
public static IntIterable peek(java.lang.Iterable<? extends java.lang.Integer> iterable,
                               IntConsumer action)
```
    A Helper function that allows to preview the result of a Iterable from a Java Iterable
    
    Parameters:
    
    iterable - that should be peeked at
    
    action - callback that receives the value before the iterable returns it
    
    Returns:
    
    a peeked iterable
  - wrap
```
public static IntIterable wrap(java.lang.Iterable<? extends java.lang.Integer> iterable)
```
    A Wrapper function that wraps a Java-Iterable into a Type Specific Iterable
    
    Parameters:
    
    iterable - that should be wrapped
    
    Returns:
    
    a type specific iterable

Class IntIterables

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IntIterables

Method Detail

map

map

flatMap

flatMap

arrayFlatMap

arrayFlatMap

filter

filter

distinct

distinct

limit

limit

sorted

sorted

peek

peek

wrap