net.emaze.dysfunctional

Class Windowing

java.lang.Object

net.emaze.dysfunctional.Windowing

public abstract class Windowing
extends Object

window, centered.

Author:

rferranti

Constructor Summary

Constructors

Constructor and Description
Windowing()

Method Summary

Modifier and Type	Method and Description
static <T> Iterator<List<Optional<T>>>	centered(int windowSize, Iterable<T> iterable) Adapts an iterable to an iterator showing a sliding centered window of the contained elements.
static <W extends Collection<Optional<T>>,T> Iterator<W>	centered(int windowSize, Iterable<T> iterable, Supplier<W> supplier) Adapts an iterable to an iterator showing a sliding centered window of the contained elements.
static <T> Iterator<List<Optional<T>>>	centered(int windowSize, Iterator<T> iterator) Adapts an iterator to an iterator showing a sliding centered window of the contained elements.
static <W extends Collection<Optional<T>>,T> Iterator<W>	centered(int windowSize, Iterator<T> iterator, Supplier<W> supplier) Adapts an iterator to an iterator showing a sliding centered window of the contained elements.
static <T> Iterator<Queue<Optional<T>>>	trails(int trailSize, Iterable<T> iterable) Adapts an iterator to an iterator showing predecessors of the contained elements.
static <T,W extends Collection<?>> Iterator<W>	trails(int trailSize, Iterable<T> iterable, Function<Queue<Optional<T>>,W> copy) Adapts an iterator to an iterator showing predecessors of the contained elements.
static <T> Iterator<Queue<Optional<T>>>	trails(int trailSize, Iterator<T> iterator) Adapts an iterator to an iterator showing predecessors of the contained elements.
static <T,W extends Collection<?>> Iterator<W>	trails(int trailSize, Iterator<T> iterator, Function<Queue<Optional<T>>,W> copy) Adapts an iterator to an iterator showing predecessors of the contained elements.
static <T> Iterator<List<T>>	window(int windowSize, Iterable<T> iterable) Adapts an iterable to an iterator showing a sliding window of the contained elements.
static <W extends Collection<T>,T> Iterator<W>	window(int windowSize, Iterable<T> iterable, Supplier<W> supplier) Adapts an iterable to an iterator showing a sliding window of the contained elements.
static <T> Iterator<List<T>>	window(int windowSize, Iterator<T> iterator) Adapts an iterator to an iterator showing a sliding window of the contained elements.
static <W extends Collection<T>,T> Iterator<W>	window(int windowSize, Iterator<T> iterator, Supplier<W> supplier) Adapts an iterator to an iterator showing a sliding window of the contained elements.

Methods inherited from class java.lang.Object

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

Constructor Detail

Windowing

public Windowing()

Method Detail

window

public static <T> Iterator<List<T>> window(int windowSize,
                                           Iterator<T> iterator)

Adapts an iterator to an iterator showing a sliding window of the contained elements. e.g: iterator: [1,2,3] windowSize: 2 -> [[1,2], [2,3]]

Type Parameters:

T - the iterator element type

Parameters:

windowSize - the window size

iterator - the iterator to be adapted

Returns:

the window iterator

window

public static <T> Iterator<List<T>> window(int windowSize,
                                           Iterable<T> iterable)

Adapts an iterable to an iterator showing a sliding window of the contained elements. e.g: iterable: [1,2,3] windowSize: 2 -> [[1,2], [2,3]]

Type Parameters:

T - the iterator element type

Parameters:

windowSize - the window size

iterable - the iterable to be adapted

Returns:

the window iterator

window

public static <W extends Collection<T>,T> Iterator<W> window(int windowSize,
                                                             Iterator<T> iterator,
                                                             Supplier<W> supplier)

Adapts an iterator to an iterator showing a sliding window of the contained elements. e.g: iterator: [1,2,3] windowSize: 2 -> [[1,2], [2,3]]

Type Parameters:

W - the window type

T - the iterator element type

Parameters:

windowSize - the window size

iterator - the iterable to be adapted

supplier - the supplier providing the window collection

Returns:

the window iterator

window

public static <W extends Collection<T>,T> Iterator<W> window(int windowSize,
                                                             Iterable<T> iterable,
                                                             Supplier<W> supplier)

Adapts an iterable to an iterator showing a sliding window of the contained elements. e.g: iterable: [1,2,3] windowSize: 2 -> [[1,2], [2,3]]

Type Parameters:

W - the window type

T - the iterator element type

Parameters:

windowSize - the window size

iterable - the iterable to be adapted

supplier - the supplier providing the window collection

Returns:

the window iterator

centered

public static <T> Iterator<List<Optional<T>>> centered(int windowSize,
                                                       Iterator<T> iterator)

Adapts an iterator to an iterator showing a sliding centered window of the contained elements. e.g: iterator: [1,2,3] windowSize: 3 -> [[nothing, just(1), just(2)], [just(1), just(2), just(3)], [just(2), just(3), nothing]]

Type Parameters:

T - the iterator element type

Parameters:

windowSize - the window size (must be an odd positive integer)

iterator - the iterator to be adapted

Returns:

the window iterator

centered

public static <T> Iterator<List<Optional<T>>> centered(int windowSize,
                                                       Iterable<T> iterable)

Adapts an iterable to an iterator showing a sliding centered window of the contained elements. e.g: iterable: [1,2,3] windowSize: 3 -> [[nothing, just(1), just(2)], [just(1), just(2), just(3)], [just(2), just(3), nothing]]

Type Parameters:

T - the iterator element type

Parameters:

windowSize - the window size (must be an odd positive integer)

iterable - the iterable to be adapted

Returns:

the window iterator

centered

public static <W extends Collection<Optional<T>>,T> Iterator<W> centered(int windowSize,
                                                                         Iterator<T> iterator,
                                                                         Supplier<W> supplier)

Adapts an iterator to an iterator showing a sliding centered window of the contained elements. e.g: iterator: [1,2,3] windowSize: 3 -> [[nothing, just(1), just(2)], [just(1), just(2), just(3)], [just(2), just(3), nothing]]

Type Parameters:

W - the window type

T - the iterator element type

Parameters:

windowSize - the window size (must be an odd positive integer)

iterator - the iterator to be adapted

supplier - the supplier providing the window collection

Returns:

the window iterator

centered

public static <W extends Collection<Optional<T>>,T> Iterator<W> centered(int windowSize,
                                                                         Iterable<T> iterable,
                                                                         Supplier<W> supplier)

Adapts an iterable to an iterator showing a sliding centered window of the contained elements. e.g: iterable: [1,2,3] windowSize: 3 -> [[nothing, just(1), just(2)], [just(1), just(2), just(3)], [just(2), just(3), nothing]]

Type Parameters:

W - the window type

T - the iterator element type

Parameters:

windowSize - the window size (must be an odd positive integer)

iterable - the iterable to be adapted

supplier - the supplier providing the window collection

Returns:

the window iterator

trails

public static <T> Iterator<Queue<Optional<T>>> trails(int trailSize,
                                                      Iterator<T> iterator)

Adapts an iterator to an iterator showing predecessors of the contained elements. This iterator always yields an alias to the same queue, beware of aliasing problems. e.g: iterator: [1,2,3,4], trailSize: 3 -> [[Nothing, Nothing, Just 1],[Nothing Just 1, Just 2], [Just 1, Just 2, Just 3], [Just 2, Just 3, Just 4]]

Type Parameters:

T - the adapted iterator element type

Parameters:

trailSize - the trail size

iterator - the iterator to be adapted

Returns:

TODO

trails

public static <T,W extends Collection<?>> Iterator<W> trails(int trailSize,
                                                             Iterator<T> iterator,
                                                             Function<Queue<Optional<T>>,W> copy)

Adapts an iterator to an iterator showing predecessors of the contained elements. Copy semantics of the internal queue yielded is controlled by the copy function. e.g: iterator: [1,2,3,4], trailSize: 3 -> [[Nothing, Nothing, Just 1],[Nothing Just 1, Just 2], [Just 1, Just 2, Just 3], [Just 2, Just 3, Just 4]]

Type Parameters:

T - the adapted iterator element type

W - the window type

Parameters:

trailSize - the trail size

iterator - the iterator to be adapted

copy - copy semantics for the internal queue

Returns:

the adapted iterator

trails

public static <T> Iterator<Queue<Optional<T>>> trails(int trailSize,
                                                      Iterable<T> iterable)

Adapts an iterator to an iterator showing predecessors of the contained elements. This iterator always yields an alias to the same queue, beware of aliasing problems. e.g: iterable: [1,2,3,4], trailSize: 3 -> [[Nothing, Nothing, Just 1],[Nothing Just 1, Just 2], [Just 1, Just 2, Just 3], [Just 2, Just 3, Just 4]]

Type Parameters:

T - the adapted iterator element type

Parameters:

trailSize - the trail size

iterable - the iterable to be adapted

Returns:

the adapted iterator

trails

public static <T,W extends Collection<?>> Iterator<W> trails(int trailSize,
                                                             Iterable<T> iterable,
                                                             Function<Queue<Optional<T>>,W> copy)

Adapts an iterator to an iterator showing predecessors of the contained elements. Copy semantics of the internal queue yielded is controlled by the copy function. e.g: iterable: [1,2,3,4], trailSize: 3 -> [[Nothing, Nothing, Just 1],[Nothing Just 1, Just 2], [Just 1, Just 2, Just 3], [Just 2, Just 3, Just 4]]

Type Parameters:

T - the adapted iterator element type

W - the window type

Parameters:

trailSize - the trail size

iterable - the iterable to be adapted

copy - copy semantics for the internal queue

Returns:

the adapted iterator