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

Class CartesianProduct<A,B>

java.lang.Object

com.jnape.palatable.lambda.functions.builtin.fn2.CartesianProduct<A,B>

Type Parameters:

A - The multiplicand Iterable element type

B - The multiplier Iterable element type

All Implemented Interfaces:

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

public final class CartesianProduct<A,B>
extends java.lang.Object
implements Fn2<java.lang.Iterable<A>,java.lang.Iterable<B>,java.lang.Iterable<Tuple2<A,B>>>

Lazily compute the cartesian product of an Iterable<A> and Iterable<B>, returning an Iterable<Tuple2<A, B>>, the products as tuples of multiplicand As and multiplier Bs.

Note that this algorithm exhaustively pairs all elements from Iterable<B> to the first element of Iterable<A> before advancing to the next element of Iterable<A>, so if Iterable<B> is infinite, only one element from Iterable<A> will ever be paired.

See Also:

Zip

Field Summary

Fields

Modifier and Type	Field	Description
private static CartesianProduct<?,?>	INSTANCE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CartesianProduct()

Method Summary

Modifier and Type	Method	Description
static <A,B> CartesianProduct<A,B>	cartesianProduct()
static <A,B> Fn1<java.lang.Iterable<B>,java.lang.Iterable<Tuple2<A,B>>>	cartesianProduct(java.lang.Iterable<A> as)
static <A,B> java.lang.Iterable<Tuple2<A,B>>	cartesianProduct(java.lang.Iterable<A> as, java.lang.Iterable<B> bs)
java.lang.Iterable<Tuple2<A,B>>	checkedApply(java.lang.Iterable<A> as, java.lang.Iterable<B> bs)

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, carry, cartesian, censor, choose, cocartesian, diMap, diMapR, discardL, flatMap, fmap, lazyZip, listens, local, pure, self, thunk, toFunction, trampolineM, zip, zip

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

apply, apply, checkedApply, compose, contraMap, diMapL, discardR, flip, toBiFunction, uncurry, widen

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

coerce

Field Detail

INSTANCE

private static final CartesianProduct<?,?> INSTANCE

Constructor Detail

CartesianProduct

private CartesianProduct()

Method Detail

checkedApply

public java.lang.Iterable<Tuple2<A,B>> checkedApply(java.lang.Iterable<A> as,
                                                          java.lang.Iterable<B> bs)

Specified by:

checkedApply in interface Fn2<java.lang.Iterable<A>,java.lang.Iterable<B>,java.lang.Iterable<Tuple2<A,B>>>

cartesianProduct

public static <A,B> CartesianProduct<A,B> cartesianProduct()

cartesianProduct

public static <A,B> Fn1<java.lang.Iterable<B>,java.lang.Iterable<Tuple2<A,B>>> cartesianProduct(java.lang.Iterable<A> as)

cartesianProduct

public static <A,B> java.lang.Iterable<Tuple2<A,B>> cartesianProduct(java.lang.Iterable<A> as,
                                                                                 java.lang.Iterable<B> bs)