net.emaze.dysfunctional

Class Zips

java.lang.Object

net.emaze.dysfunctional.Zips

public abstract class Zips
extends Object

longest, shortest, counted.

Author:

rferranti

Constructor Summary

Constructors

Constructor and Description
Zips()

Method Summary

Modifier and Type	Method and Description
static <CT,ET> Iterator<Pair<CT,ET>>	counted(ET[] array, Range<CT> range) Creates an iterator yielding values from the source iterator and its index.
static <CT,ET> Iterator<Pair<CT,ET>>	counted(Iterable<ET> iterable, Range<CT> range) Creates an iterator yielding values from the source iterator and its index.
static <T> Iterator<Pair<Integer,T>>	counted(Iterable<T> iterable) Creates an iterator yielding values from the source iterator and its index.
static <CT,ET> Iterator<Pair<CT,ET>>	counted(Iterator<ET> iterator, Range<CT> range) Creates an iterator yielding values from the source iterator and its index.
static <T> Iterator<Pair<Integer,T>>	counted(Iterator<T> iterator) Creates an iterator yielding values from the source iterator and its index.
static <T> Iterator<Pair<Integer,T>>	counted(T... array) Creates an iterator yielding values from the source iterator and its index.
static <T1,T2> Iterator<Pair<Maybe<T1>,Maybe<T2>>>	longest(Iterable<T1> former, Iterable<T2> latter) Transforms two iterables to an iterator of tuples, containing Maybe.just(elements) of both iterables occurring at the same position.
static <T1,T2> Iterator<Pair<Maybe<T1>,Maybe<T2>>>	longest(Iterator<T1> former, Iterator<T2> latter) Transforms two iterators to an iterator of tuples, containing Maybe.just(elements) of both iterators occurring at the same position.
static <T1,T2> Iterator<Pair<Maybe<T1>,Maybe<T2>>>	longest(T1[] former, T2[] latter) Transforms two arrays to an iterator of tuples, containing Maybe.just(elements) of both arrays occurring at the same position.
static <T1,T2> Iterator<Pair<T1,T2>>	shortest(Iterable<T1> former, Iterable<T2> latter) Transforms two iterables to an iterator of tuples, containing elements of both iterables occurring at the same position; the iterator stops when the shortest input iterable is exhausted.
static <T1,T2> Iterator<Pair<T1,T2>>	shortest(Iterator<T1> former, Iterator<T2> latter) Transforms two iterators to an iterator of tuples, containing elements of both iterators occurring at the same position; the iterator stops when the shortest input iterable is exhausted.
static <T1,T2> Iterator<Pair<T1,T2>>	shortest(T1[] former, T2[] latter) Transforms two arrays to an iterator of tuples, containing elements of both arrays occurring at the same position; the iterator stops when the shortest input iterable is exhausted.

Methods inherited from class java.lang.Object

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

Constructor Detail

Zips

public Zips()

Method Detail

shortest

public static <T1,T2> Iterator<Pair<T1,T2>> shortest(Iterable<T1> former,
                                                     Iterable<T2> latter)

Transforms two iterables to an iterator of tuples, containing elements of both iterables occurring at the same position; the iterator stops when the shortest input iterable is exhausted. E.g: Zips.shortest([1,2],['a','b','c']) -> [1,'a'], [2,'b']

Type Parameters:

T1 - former element type parameter

T2 - latter element type parameter

Parameters:

former - the former iterable

latter - the latter iterable

Returns:

the resulting shortest convolved iterator

shortest

public static <T1,T2> Iterator<Pair<T1,T2>> shortest(Iterator<T1> former,
                                                     Iterator<T2> latter)

Transforms two iterators to an iterator of tuples, containing elements of both iterators occurring at the same position; the iterator stops when the shortest input iterable is exhausted. E.g: Zips.shortest([1,2],['a','b','c']) -> [1,'a'], [2,'b']

Type Parameters:

T1 - former element type parameter

T2 - latter element type parameter

Parameters:

former - the former iterator

latter - the latter iterator

Returns:

the resulting shortest convolved iterator

shortest

public static <T1,T2> Iterator<Pair<T1,T2>> shortest(T1[] former,
                                                     T2[] latter)

Transforms two arrays to an iterator of tuples, containing elements of both arrays occurring at the same position; the iterator stops when the shortest input iterable is exhausted. E.g: Zips.shortest([1,2],['a','b','c']) -> [1,'a'], [2,'b']

Type Parameters:

T1 - former element type parameter

T2 - latter element type parameter

Parameters:

former - the former array

latter - the latter array

Returns:

the resulting shortest convolved iterator

longest

public static <T1,T2> Iterator<Pair<Maybe<T1>,Maybe<T2>>> longest(Iterable<T1> former,
                                                                  Iterable<T2> latter)

Transforms two iterables to an iterator of tuples, containing Maybe.just(elements) of both iterables occurring at the same position. If the iterables are of uneven length, missing values are filled-in with Maybe.nothing(). Iteration continues until the longest iterable is exhausted. E.g: Zip.longest([1,2],['a','b','c']) -> [(just 1,just 'a'),(just 2 ,just 'b'), (nothing ,just 'c')]

Type Parameters:

T1 - the former element type parameter

T2 - the latter element type parameter

Parameters:

former - the former iterable

latter - the latter iterable

Returns:

the resulting longest convolved iterator

longest

public static <T1,T2> Iterator<Pair<Maybe<T1>,Maybe<T2>>> longest(Iterator<T1> former,
                                                                  Iterator<T2> latter)

Transforms two iterators to an iterator of tuples, containing Maybe.just(elements) of both iterators occurring at the same position. If the iterables are of uneven length, missing values are filled-in with Maybe.nothing(). Iteration continues until the longest iterable is exhausted. E.g: Zip.longest([1,2],['a','b','c']) -> [(just 1,just 'a'),(just 2 ,just 'b'), (nothing ,just 'c')]

Type Parameters:

T1 - the former element type parameter

T2 - the latter element type parameter

Parameters:

former - the former iterator

latter - the latter iterator

Returns:

the resulting longest convolved iterator

longest

public static <T1,T2> Iterator<Pair<Maybe<T1>,Maybe<T2>>> longest(T1[] former,
                                                                  T2[] latter)

Transforms two arrays to an iterator of tuples, containing Maybe.just(elements) of both arrays occurring at the same position. If the iterables are of uneven length, missing values are filled-in with Maybe.nothing(). Iteration continues until the longest iterable is exhausted. E.g: Zip.longest([1,2],['a','b','c']) -> [(just 1,just 'a'),(just 2 ,just 'b'), (nothing ,just 'c')]

Type Parameters:

T1 - the former element type parameter

T2 - the latter element type parameter

Parameters:

former - the former array

latter - the latter array

Returns:

the resulting longest convolved iterator

counted

public static <CT,ET> Iterator<Pair<CT,ET>> counted(Iterator<ET> iterator,
                                                    Range<CT> range)

Creates an iterator yielding values from the source iterator and its index. E.g: counted(["a", "b","c"], [0..inf]) -> [(0,"a"), (1, "b"), (2, "c")]

Type Parameters:

CT - the counter type

ET - the element type

Parameters:

iterator - the source iterator

range - the source range

Returns:

the resulting iterator

counted

public static <T> Iterator<Pair<Integer,T>> counted(Iterator<T> iterator)

Creates an iterator yielding values from the source iterator and its index. E.g: counted(["a", "b","c"]) -> [(0,"a"), (1, "b"), (2, "c")]

Type Parameters:

T - the element type

Parameters:

iterator - the source iterator

Returns:

the resulting iterator

counted

public static <T> Iterator<Pair<Integer,T>> counted(Iterable<T> iterable)

Creates an iterator yielding values from the source iterator and its index. E.g: counted(["a", "b","c"]) -> [(0,"a"), (1, "b"), (2, "c")]

Type Parameters:

T - the element type

Parameters:

iterable - the source iterable

Returns:

the resulting iterator

counted

public static <CT,ET> Iterator<Pair<CT,ET>> counted(Iterable<ET> iterable,
                                                    Range<CT> range)

Creates an iterator yielding values from the source iterator and its index. E.g: counted(["a", "b","c"], [0..inf]) -> [(0,"a"), (1, "b"), (2, "c")]

Type Parameters:

CT - the counter type

ET - the element type

Parameters:

iterable - the source iterable

range - the source range

Returns:

the resulting iterator

counted

public static <T> Iterator<Pair<Integer,T>> counted(T... array)

Creates an iterator yielding values from the source iterator and its index. E.g: counted(["a", "b","c"]) -> [(0,"a"), (1, "b"), (2, "c")]

Type Parameters:

T - the element type

Parameters:

array - the source array

Returns:

the resulting iterator

counted

public static <CT,ET> Iterator<Pair<CT,ET>> counted(ET[] array,
                                                    Range<CT> range)

Creates an iterator yielding values from the source iterator and its index. E.g: counted(["a", "b","c"], [0..inf]) -> [(0,"a"), (1, "b"), (2, "c")]

Type Parameters:

CT - the counter type

ET - the element type

Parameters:

array - the source array

range - the source range

Returns:

the resulting iterator