net.emaze.dysfunctional

Class Multiplexing

java.lang.Object

net.emaze.dysfunctional.Multiplexing

public abstract class Multiplexing
extends Object

flatten, chain, mux, muxLongest, demux, demuxLongest, roundrobin.

Author:

rferranti

Constructor Summary

Constructors

Constructor and Description
Multiplexing()

Method Summary

Methods

Modifier and Type	Method and Description
static <E> Iterator<List<E>>	batch(int batchSize, E[] array) Demultiplexes elements from the source array into an iterator of channels.
static <C extends Collection<E>,E> Iterator<C>	batch(int batchSize, E[] array, Provider<C> channelProvider) Demultiplexes elements from the source array into an iterator of channels.
static <E> Iterator<List<E>>	batch(int batchSize, Iterable<E> iterable) Demultiplexes elements from the source iterable into an iterator of channels.
static <C extends Collection<E>,E> Iterator<C>	batch(int batchSize, Iterable<E> iterable, Provider<C> channelProvider) Demultiplexes elements from the source iterable into an iterator of channels.
static <E> Iterator<List<E>>	batch(int batchSize, Iterator<E> iterator) Demultiplexes elements from the source iterator into an iterator of channels.
static <C extends Collection<E>,E> Iterator<C>	batch(int batchSize, Iterator<E> iterator, Provider<C> channelProvider) Demultiplexes elements from the source iterator into an iterator of channels.
static <E,I extends Iterator<E>> Iterator<E>	chain(I first, I second) Flattens passed iterators of E to an iterator of E.
static <E,I extends Iterator<E>> Iterator<E>	chain(I first, I second, I third) Flattens passed iterators of E to an iterator of E.
static <E,I extends Iterator<E>> Iterator<E>	chain(Iterable<I> iterable) Flattens an iterable of iterators of E to an iterator of E.
static <E,I extends Iterator<E>> Iterator<E>	chain(Iterator<I> iterators) Flattens an iterator of iterators of E to an iterator of E.
static <E> Iterator<E>	cycle(E first, E second) Creates an infinite iterator that issues elements from the parameter cyclicly.
static <E> Iterator<E>	cycle(E first, E second, E third) Creates an infinite iterator that issues elements from the parameter cyclicly.
static <E> Iterator<E>	cycle(Iterable<E> iterable) Creates an infinite iterator that issues elements from the parameter cyclicly.
static <E> Iterator<E>	cycle(Iterator<E> iterator) Creates an infinite iterator that issues elements from the parameter cyclicly.
static <E,I extends Iterable<E>> Iterator<E>	flatten(I first, I second) Flattens passed iterables of E to an iterator of E.
static <E,I extends Iterable<E>> Iterator<E>	flatten(I first, I second, I third) Flattens passed iterables of E to an iterator of E.
static <E,I extends Iterable<E>> Iterator<E>	flatten(Iterable<I> iterables) Flattens an iterable of iterables of E to an iterator of E.E.g: flatten([1,2], [3,4]) -> [1,2,3,4]
static <E,I extends Iterable<E>> Iterator<E>	flatten(Iterator<I> iterables) Flattens an iterator of iterables of E to an iterator of E.
static <E,I extends Iterator<E>> Iterator<E>	roundrobin(Iterable<I> iterable) Multiplexes an iterator of iterators into an iterator.
static <E> Iterator<E>	roundrobin(Iterator<E> first, Iterator<E> second) Multiplexes an iterator of iterators into an iterator.
static <E> Iterator<E>	roundrobin(Iterator<E> first, Iterator<E> second, Iterator<E> third) Multiplexes an iterator of iterators into an iterator.
static <E,I extends Iterator<E>> Iterator<E>	roundrobin(Iterator<I> iterators) Multiplexes an iterator of iterators into an iterator.
static <E,I extends Iterator<E>> Iterator<Maybe<E>>	roundrobinLongest(Iterable<I> iterable) Multiplexes an iterable of iterators into a single iterator.
static <E> Iterator<Maybe<E>>	roundrobinLongest(Iterator<E> first, Iterator<E> second) Multiplexes two iterators into a single iterator.
static <E> Iterator<Maybe<E>>	roundrobinLongest(Iterator<E> first, Iterator<E> second, Iterator<E> third) Multiplexes three iterators into a single iterator.
static <E,I extends Iterator<E>> Iterator<Maybe<E>>	roundrobinLongest(Iterator<I> iterators) Multiplexes an iterator of iterators into a single iterator.
static <E,I extends Iterator<E>> Iterator<E>	roundrobinShortest(Iterable<I> iterable) Multiplexes an iterable of iterators into a single iterator.
static <E> Iterator<E>	roundrobinShortest(Iterator<E> first, Iterator<E> second) Multiplexes two iterators into a single iterator.
static <E> Iterator<E>	roundrobinShortest(Iterator<E> first, Iterator<E> second, Iterator<E> third) Multiplexes three iterators into a single iterator.
static <E,I extends Iterator<E>> Iterator<E>	roundrobinShortest(Iterator<I> iterators) Multiplexes an iterator of iterators into a single iterator.
static <E> Iterator<List<E>>	unchain(int channelSize, E... array) Demultiplexes elements from the source array into an iterator of channels.
static <E> Iterator<List<E>>	unchain(int channelSize, Iterable<E> iterable) Demultiplexes elements from the source iterable into an iterator of channels.
static <C extends Collection<E>,E> Iterator<C>	unchain(int channelSize, Iterable<E> iterable, Provider<C> channelProvider) Demultiplexes elements from the source iterable into an iterator of channels.
static <E> Iterator<List<E>>	unchain(int channelSize, Iterator<E> iterator) Demultiplexes elements from the source iterator into an iterator of channels.
static <C extends Collection<E>,E> Iterator<C>	unchain(int channelSize, Iterator<E> iterator, Provider<C> channelProvider) Demultiplexes elements from the source iterator into an iterator of channels.
static <C extends Collection<E>,E> Iterator<C>	unchain(int channelSize, Provider<C> channelProvider, E... array) Demultiplexes elements from the source array into an iterator of channels.
static <E> Iterator<List<Maybe<E>>>	unchainWithExactChannelSize(int channelSize, E... array) Demultiplexes elements from the source array into an iterator of channels.
static <E> Iterator<List<Maybe<E>>>	unchainWithExactChannelSize(int channelSize, Iterable<E> iterable) Demultiplexes elements from the source array into an iterator of channels.
static <C extends Collection<Maybe<E>>,E> Iterator<C>	unchainWithExactChannelSize(int channelSize, Iterable<E> iterable, Provider<C> channelProvider) Demultiplexes elements from the source array into an iterator of channels.
static <E> Iterator<List<Maybe<E>>>	unchainWithExactChannelSize(int channelSize, Iterator<E> iterator) Demultiplexes elements from the source array into an iterator of channels.
static <C extends Collection<Maybe<E>>,E> Iterator<C>	unchainWithExactChannelSize(int channelSize, Iterator<E> iterator, Provider<C> channelProvider) Demultiplexes elements from the source array into an iterator of channels.
static <C extends Collection<Maybe<E>>,E> Iterator<C>	unchainWithExactChannelSize(int channelSize, Provider<C> channelProvider, E... array) Demultiplexes elements from the source array into an iterator of channels.

Methods inherited from class java.lang.Object

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

Constructor Detail

Multiplexing

public Multiplexing()

Method Detail

flatten

public static <E,I extends Iterable<E>> Iterator<E> flatten(Iterator<I> iterables)

Flattens an iterator of iterables of E to an iterator of E. E.g: flatten([1,2], [3,4]) -> [1,2,3,4]

Type Parameters:

E - the iterable element type

I - the iterable type

Parameters:

iterables - the iterator of iterables to be flattened

Returns:

the flattened iterator

flatten

public static <E,I extends Iterable<E>> Iterator<E> flatten(Iterable<I> iterables)

Flattens an iterable of iterables of E to an iterator of E.E.g: flatten([1,2], [3,4]) -> [1,2,3,4]

Type Parameters:

E - the iterable element type

I - the iterable type

Parameters:

iterables - the iterable of iterables to be flattened

Returns:

the flattened iterator

flatten

public static <E,I extends Iterable<E>> Iterator<E> flatten(I first,
                                            I second)

Flattens passed iterables of E to an iterator of E. E.g: flatten([1,2], [3,4]) -> [1,2,3,4]

Type Parameters:

E - the iterable element type

I - the iterable type

Parameters:

first - the first iterable to be flattened

second - the second iterable to be flattened

Returns:

the flattened iterator

flatten

public static <E,I extends Iterable<E>> Iterator<E> flatten(I first,
                                            I second,
                                            I third)

Flattens passed iterables of E to an iterator of E. E.g: flatten([1,2], [3,4], [5,6]) -> [1,2,3,4,5,6]

Type Parameters:

E - the iterable element type

I - the iterable type

Parameters:

first - the first iterable to be flattened

second - the second iterable to be flattened

third - the third iterable to be flattened

Returns:

the flattened iterator

chain

public static <E,I extends Iterator<E>> Iterator<E> chain(Iterator<I> iterators)

Flattens an iterator of iterators of E to an iterator of E. E.g: chain([1,2], [3,4]) -> [1,2,3,4]

Type Parameters:

E - the iterator element type

I - the iterator type

Parameters:

iterators - the source iterators

Returns:

the flattened iterator

chain

public static <E,I extends Iterator<E>> Iterator<E> chain(Iterable<I> iterable)

Flattens an iterable of iterators of E to an iterator of E. E.g: chain([1,2], [3,4]) -> [1,2,3,4]

Type Parameters:

E - the iterator element type

I - the iterator type

Parameters:

iterable - the source iterable

Returns:

the flattened iterator

chain

public static <E,I extends Iterator<E>> Iterator<E> chain(I first,
                                          I second)

Flattens passed iterators of E to an iterator of E. E.g: chain([1,2], [3,4]) -> [1,2,3,4]

Type Parameters:

E - the iterator element type

I - the iterator type

Parameters:

first - the first iterator to be flattened

second - the second iterator to be flattened

Returns:

the flattened iterator

chain

public static <E,I extends Iterator<E>> Iterator<E> chain(I first,
                                          I second,
                                          I third)

Flattens passed iterators of E to an iterator of E. E.g: chain([1,2], [3,4], [5,6]) -> [1,2,3,4,5,6]

Type Parameters:

E - the iterator element type

I - the iterator type

Parameters:

first - the first iterator to be flattened

second - the second iterator to be flattened

third - the third iterator to be flattened

Returns:

the flattened iterator

batch

public static <C extends Collection<E>,E> Iterator<C> batch(int batchSize,
                                            Iterator<E> iterator,
                                            Provider<C> channelProvider)

Demultiplexes elements from the source iterator into an iterator of channels.

Type Parameters:

C - the channel collection type

E - the element type

Parameters:

batchSize - maximum size of the channel

iterator - the source iterator

channelProvider - a provider used to create channels

Returns:

an iterator of channels

batch

public static <E> Iterator<List<E>> batch(int batchSize,
                          Iterator<E> iterator)

Demultiplexes elements from the source iterator into an iterator of channels.

Type Parameters:

E - the element type

Parameters:

batchSize - maximum size of the channel

iterator - the source iterator

Returns:

an iterator of channels

batch

public static <C extends Collection<E>,E> Iterator<C> batch(int batchSize,
                                            Iterable<E> iterable,
                                            Provider<C> channelProvider)

Demultiplexes elements from the source iterable into an iterator of channels.

Type Parameters:

C - the channel collection type

E - the element type

Parameters:

batchSize - maximum size of the channel

iterable - the source iterable

channelProvider - the provider used to create channels

Returns:

an iterator of channels

batch

public static <E> Iterator<List<E>> batch(int batchSize,
                          Iterable<E> iterable)

Demultiplexes elements from the source iterable into an iterator of channels.

Type Parameters:

E - the element type

Parameters:

batchSize - maximum size of the channel

iterable - the source iterable

Returns:

an iterator of channels

batch

public static <C extends Collection<E>,E> Iterator<C> batch(int batchSize,
                                            E[] array,
                                            Provider<C> channelProvider)

Demultiplexes elements from the source array into an iterator of channels.

Type Parameters:

C - the channel collection type

E - the element type

Parameters:

batchSize - maximum size of the channel

array - the source array

channelProvider - the provider used to create channels

Returns:

an iterator of channels

batch

public static <E> Iterator<List<E>> batch(int batchSize,
                          E[] array)

Demultiplexes elements from the source array into an iterator of channels.

Type Parameters:

E - the element type

Parameters:

batchSize - maximum size of the channel

array - the source array

Returns:

an iterator of channels

roundrobin

public static <E,I extends Iterator<E>> Iterator<E> roundrobin(Iterator<I> iterators)

Multiplexes an iterator of iterators into an iterator. Iteration stops when every element from every source has been consumed. roundRobin([1,2], [3], [4,5]) -> [1,3,4,2,5]

Type Parameters:

E - the element type

I - the iterator type

Parameters:

iterators - the source iterator

Returns:

an iterator yielding multiplexed elements

roundrobin

public static <E,I extends Iterator<E>> Iterator<E> roundrobin(Iterable<I> iterable)

Multiplexes an iterator of iterators into an iterator. Iteration stops when every element from every source has been consumed. roundRobin([1,2], [3], [4,5]) -> [1,3,4,2,5]

Type Parameters:

E - the element type

I - the iterator type

Parameters:

iterable - the source iterable

Returns:

an iterator yielding multiplexed elements

roundrobin

public static <E> Iterator<E> roundrobin(Iterator<E> first,
                         Iterator<E> second)

Multiplexes an iterator of iterators into an iterator. Iteration stops when every element from every source has been consumed. roundRobin([1,2], [3]) -> [1,3,2]

Type Parameters:

E - the element type

Parameters:

first - the first source iterator

second - the second source iterator

Returns:

an iterator yielding multiplexed elements

roundrobin

public static <E> Iterator<E> roundrobin(Iterator<E> first,
                         Iterator<E> second,
                         Iterator<E> third)

Multiplexes an iterator of iterators into an iterator. Iteration stops when every element from every source has been consumed. roundRobin([1,2], [3], [4,5,6]) -> [1,3,4,2,5,6]

Type Parameters:

E - the element type

Parameters:

first - the first source iterator

second - the second source iterator

third - the third source iterator

Returns:

an iterator yielding multiplexed elements

roundrobinShortest

public static <E,I extends Iterator<E>> Iterator<E> roundrobinShortest(Iterator<I> iterators)

Multiplexes an iterator of iterators into a single iterator. The iteration stops whenever any of the source iterators is empty causing the same number of elements to be consumed from every iterator. roundrobinShortest([1,2,3], [4,5]) -> [1,4,2,5]

Type Parameters:

E - the element type

I - the iterator type

Parameters:

iterators - the iterator of iterators to be multiplexed

Returns:

an iterator containing multiplexed elements

roundrobinShortest

public static <E,I extends Iterator<E>> Iterator<E> roundrobinShortest(Iterable<I> iterable)

Multiplexes an iterable of iterators into a single iterator. The iteration stops whenever any of the source iterators is empty causing the same number of elements to be consumed from every iterator. E.g: roundrobinShortest([1,2,3], [4,5]) -> [1,4,2,5]

Type Parameters:

E - the element type

I - the source iterator type

Parameters:

iterable - the source iterable

Returns:

an iterator containing multiplexed elements

roundrobinShortest

public static <E> Iterator<E> roundrobinShortest(Iterator<E> first,
                                 Iterator<E> second)

Multiplexes two iterators into a single iterator. The iteration stops whenever any of the source iterators is empty causing the same number of elements to be consumed from every iterator. E.g: roundrobinShortest([1,2], [3]) -> [1,3]

Type Parameters:

E - the element type

Parameters:

first - the first source iterator

second - the second source iterator

Returns:

an iterator containing multiplexed elements

roundrobinShortest

public static <E> Iterator<E> roundrobinShortest(Iterator<E> first,
                                 Iterator<E> second,
                                 Iterator<E> third)

Multiplexes three iterators into a single iterator. The iteration stops whenever any of the source iterators is empty causing the same number of elements to be consumed from every iterator. E.g: roundrobinShortest([1,2], [3], [4]) -> [1, 3, 4]

Type Parameters:

E - the element type

Parameters:

first - the first source iterator

second - the second source iterator

third - the third source iterator

Returns:

an iterator containing multiplexed elements

roundrobinLongest

public static <E,I extends Iterator<E>> Iterator<Maybe<E>> roundrobinLongest(Iterator<I> iterators)

Multiplexes an iterator of iterators into a single iterator. The iteration stops when every source iterator is empty.E.g: roundrobinLongest([1,2], [4]) -> [just 1, just 4, just 2, nothing]

Type Parameters:

E - the element type

I - the iterator type

Parameters:

iterators - the source iterator

Returns:

an iterator containing multiplexed elements

roundrobinLongest

public static <E,I extends Iterator<E>> Iterator<Maybe<E>> roundrobinLongest(Iterable<I> iterable)

Multiplexes an iterable of iterators into a single iterator. The iteration stops when every source iterator is empty.E.g: roundrobinLongest([1,2], [4]) -> [just 1, just 4, just 2, nothing]

Type Parameters:

E - the element type

I - the iterator type

Parameters:

iterable - the source iterable

Returns:

an iterator containing multiplexed elements

roundrobinLongest

public static <E> Iterator<Maybe<E>> roundrobinLongest(Iterator<E> first,
                                       Iterator<E> second)

Multiplexes two iterators into a single iterator. The iteration stops when every source iterator is empty.E.g: roundrobinLongest([1,2], [4]) -> [just 1, just 4, just 2, nothing]

Type Parameters:

E - the element type

Parameters:

first - the first source iterator

second - the second source iterator

Returns:

an iterator containing multiplexed elements

roundrobinLongest

public static <E> Iterator<Maybe<E>> roundrobinLongest(Iterator<E> first,
                                       Iterator<E> second,
                                       Iterator<E> third)

Multiplexes three iterators into a single iterator. The iteration stops when every source iterator is empty. E.g: roundrobinLongest([1,2], [4], [5]) -> [just 1, just 4, just 5, just 2, nothing, nothing]

Type Parameters:

E - the element type

Parameters:

first - the first source iterator

second - the second source iterator

third - the third source iterator

Returns:

an iterator containing multiplexed elements

cycle

public static <E> Iterator<E> cycle(Iterator<E> iterator)

Creates an infinite iterator that issues elements from the parameter cyclicly.

Type Parameters:

E - the element type

Parameters:

iterator - the iterator to cycle

Returns:

an iterator that cyclicly returns the elements from the argument

cycle

public static <E> Iterator<E> cycle(Iterable<E> iterable)

Creates an infinite iterator that issues elements from the parameter cyclicly.

Type Parameters:

E - the element type

Parameters:

iterable - the iterable to cycle

Returns:

an iterator that cyclicly returns the elements from the argument

cycle

public static <E> Iterator<E> cycle(E first,
                    E second)

Creates an infinite iterator that issues elements from the parameter cyclicly.

Type Parameters:

E - the element type

Parameters:

first - the first element to consider while cycling

second - the second element to consider while cycling

Returns:

an iterator that cyclicly returns the elements from the arguments

cycle

public static <E> Iterator<E> cycle(E first,
                    E second,
                    E third)

Creates an infinite iterator that issues elements from the parameter cyclicly.

Type Parameters:

E - the element type

Parameters:

first - the first element to consider while cycling

second - the second element to consider while cycling

third - the third element to consider while cycling

Returns:

an iterator that cyclicly returns the elements from the arguments

unchain

public static <C extends Collection<E>,E> Iterator<C> unchain(int channelSize,
                                              Iterator<E> iterator,
                                              Provider<C> channelProvider)

Demultiplexes elements from the source iterator into an iterator of channels.

Type Parameters:

C - the channel collection type

E - the element type

Parameters:

channelSize - size of the channel

iterator - the source iterator

channelProvider - a provider used to create channels

Returns:

an iterator of channels

unchain

public static <E> Iterator<List<E>> unchain(int channelSize,
                            Iterator<E> iterator)

Demultiplexes elements from the source iterator into an iterator of channels.

Type Parameters:

E - the element type

Parameters:

channelSize - size of the channel

iterator - the source iterator

Returns:

an iterator of channels

unchain

public static <C extends Collection<E>,E> Iterator<C> unchain(int channelSize,
                                              Iterable<E> iterable,
                                              Provider<C> channelProvider)

Demultiplexes elements from the source iterable into an iterator of channels.

Type Parameters:

C - the channel collection type

E - the element type

Parameters:

channelSize - size of the channel

iterable - the source iterable

channelProvider - the provider used to create channels

Returns:

an iterator of channels

unchain

public static <E> Iterator<List<E>> unchain(int channelSize,
                            Iterable<E> iterable)

Demultiplexes elements from the source iterable into an iterator of channels.

Type Parameters:

E - the element type

Parameters:

channelSize - size of the channel

iterable - the source iterable

Returns:

an iterator of channels

unchain

public static <C extends Collection<E>,E> Iterator<C> unchain(int channelSize,
                                              Provider<C> channelProvider,
                                              E... array)

Demultiplexes elements from the source array into an iterator of channels.

Type Parameters:

C - the channel collection type

E - the element type

Parameters:

channelSize - size of the channel

array - the source array

channelProvider - the provider used to create channels

Returns:

an iterator of channels

unchain

public static <E> Iterator<List<E>> unchain(int channelSize,
                            E... array)

Demultiplexes elements from the source array into an iterator of channels.

Type Parameters:

E - the element type

Parameters:

channelSize - size of the channel

array - the source array

Returns:

an iterator of channels

unchainWithExactChannelSize

public static <C extends Collection<Maybe<E>>,E> Iterator<C> unchainWithExactChannelSize(int channelSize,
                                                                         Iterator<E> iterator,
                                                                         Provider<C> channelProvider)

Demultiplexes elements from the source array into an iterator of channels.

Type Parameters:

C - the channel collection type

E - the element type

Parameters:

channelSize - size of the channel

iterator - the source iterator

channelProvider - the provider used to create channels

Returns:

an iterator of channels

unchainWithExactChannelSize

public static <E> Iterator<List<Maybe<E>>> unchainWithExactChannelSize(int channelSize,
                                                       Iterator<E> iterator)

Demultiplexes elements from the source array into an iterator of channels.

Type Parameters:

E - the element type

Parameters:

channelSize - size of the channel

iterator - the source iterator

Returns:

an iterator of channels

unchainWithExactChannelSize

public static <C extends Collection<Maybe<E>>,E> Iterator<C> unchainWithExactChannelSize(int channelSize,
                                                                         Iterable<E> iterable,
                                                                         Provider<C> channelProvider)

Demultiplexes elements from the source array into an iterator of channels.

Type Parameters:

C - the channel collection type

E - the element type

Parameters:

channelSize - size of the channel

iterable - the source iterable

channelProvider - the provider used to create channels

Returns:

an iterator of channels

unchainWithExactChannelSize

public static <E> Iterator<List<Maybe<E>>> unchainWithExactChannelSize(int channelSize,
                                                       Iterable<E> iterable)

Demultiplexes elements from the source array into an iterator of channels.

Type Parameters:

E - the element type

Parameters:

channelSize - size of the channel

iterable - the source iterable

Returns:

an iterator of channels

unchainWithExactChannelSize

public static <C extends Collection<Maybe<E>>,E> Iterator<C> unchainWithExactChannelSize(int channelSize,
                                                                         Provider<C> channelProvider,
                                                                         E... array)

Demultiplexes elements from the source array into an iterator of channels.

Type Parameters:

C - the channel collection type

E - the element type

Parameters:

channelSize - size of the channel

channelProvider - the provider used to create channels

array - the source array

Returns:

an iterator of channels

unchainWithExactChannelSize

public static <E> Iterator<List<Maybe<E>>> unchainWithExactChannelSize(int channelSize,
                                                       E... array)

Demultiplexes elements from the source array into an iterator of channels.

Type Parameters:

E - the element type

Parameters:

channelSize - size of the channel

array - the source array

Returns:

an iterator of channels