Package com.jnape.palatable.lambda.functions.builtin.fn1

Class Flatten<A>

java.lang.Object

com.jnape.palatable.lambda.functions.builtin.fn1.Flatten<A>

Type Parameters:

A - the nested Iterable element type

All Implemented Interfaces:

Fn1<java.lang.Iterable<? extends java.lang.Iterable<? extends A>>,java.lang.Iterable<A>>, Applicative<java.lang.Iterable<A>,Fn1<java.lang.Iterable<? extends java.lang.Iterable<? extends A>>,?>>, Cartesian<java.lang.Iterable<? extends java.lang.Iterable<? extends A>>,java.lang.Iterable<A>,Fn1<?,?>>, Cocartesian<java.lang.Iterable<? extends java.lang.Iterable<? extends A>>,java.lang.Iterable<A>,Fn1<?,?>>, Contravariant<java.lang.Iterable<? extends java.lang.Iterable<? extends A>>,Profunctor<?,java.lang.Iterable<A>,Fn1<?,?>>>, Functor<java.lang.Iterable<A>,Fn1<java.lang.Iterable<? extends java.lang.Iterable<? extends A>>,?>>, Profunctor<java.lang.Iterable<? extends java.lang.Iterable<? extends A>>,java.lang.Iterable<A>,Fn1<?,?>>, Monad<java.lang.Iterable<A>,Fn1<java.lang.Iterable<? extends java.lang.Iterable<? extends A>>,?>>, MonadReader<java.lang.Iterable<? extends java.lang.Iterable<? extends A>>,java.lang.Iterable<A>,Fn1<java.lang.Iterable<? extends java.lang.Iterable<? extends A>>,?>>, MonadRec<java.lang.Iterable<A>,Fn1<java.lang.Iterable<? extends java.lang.Iterable<? extends A>>,?>>, MonadWriter<java.lang.Iterable<? extends java.lang.Iterable<? extends A>>,java.lang.Iterable<A>,Fn1<java.lang.Iterable<? extends java.lang.Iterable<? extends A>>,?>>

public final class Flatten<A>
extends java.lang.Object
implements Fn1<java.lang.Iterable<? extends java.lang.Iterable<? extends A>>,java.lang.Iterable<A>>

Given a nested Iterable of Iterables, return a lazily flattening Iterable of the nested elements.

Field Summary

Fields

Modifier and Type	Field	Description
private static Flatten<?>	INSTANCE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Flatten()

Method Summary

Modifier and Type	Method	Description
java.lang.Iterable<A>	checkedApply(java.lang.Iterable<? extends java.lang.Iterable<? extends A>> iterables)	Invoke this function with the given argument, potentially throwing any Throwable.
static <A> Flatten<A>	flatten()
static <A> java.lang.Iterable<A>	flatten(java.lang.Iterable<? extends java.lang.Iterable<? extends A>> as)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jnape.palatable.lambda.functions.Fn1

andThen, apply, carry, cartesian, censor, choose, cocartesian, compose, contraMap, diMap, diMapL, diMapR, discardL, discardR, flatMap, fmap, lazyZip, listens, local, pure, self, thunk, toFunction, trampolineM, widen, zip, zip

Methods inherited from interface com.jnape.palatable.lambda.functor.Functor

coerce

Field Detail

INSTANCE

private static final Flatten<?> INSTANCE

Constructor Detail

Flatten

private Flatten()

Method Detail

checkedApply

public java.lang.Iterable<A> checkedApply(java.lang.Iterable<? extends java.lang.Iterable<? extends A>> iterables)

Description copied from interface: Fn1

Invoke this function with the given argument, potentially throwing any Throwable.

Specified by:

checkedApply in interface Fn1<java.lang.Iterable<? extends java.lang.Iterable<? extends A>>,java.lang.Iterable<A>>

Parameters:

iterables - the argument

Returns:

the result of the function application

flatten

public static <A> Flatten<A> flatten()

flatten

public static <A> java.lang.Iterable<A> flatten(java.lang.Iterable<? extends java.lang.Iterable<? extends A>> as)