F2W (core 4.5 API)

java.lang.Object
- fj.F2W<A,B,C>

All Implemented Interfaces:

F2<A,B,C>

Direct Known Subclasses:

F2W.F2WFunc
```
public abstract class F2W<A,B,C>
extends java.lang.Object
implements F2<A,B,C>
```
Created by MarkPerry on 22/01/2015.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class F2W.F2WFunc<A,B,C>

Nested Classes
Modifier and Type	Class and Description
`static class`	`F2W.F2WFunc<A,B,C>`

Constructor Summary

Constructors
Constructor and Description

F2W()

Constructors
Constructor and Description
`F2W()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`F2W<Array<A>,Array<B>,Array<C>>`	`arrayM()` Promotes this function to a function on Arrays.
`<X,Y> F2W<X,Y,C>`	`contramap(F<X,A> f, F<Y,B> g)`
`<Z> F2W<Z,B,C>`	`contramapFirst(F<Z,A> f)`
`<Z> F2W<A,Z,C>`	`contramapSecond(F<Z,B> f)`
`F1W<A,F<B,C>>`	`curry()` Curries this wrapped function to a wrapped function of arity-1 that returns another wrapped function.
`F1W<B,C>`	`f(A a)` Partial application.
`F2W<B,A,C>`	`flip()` Flips the arguments of this function.
`F2W<java.lang.Iterable<A>,java.lang.Iterable<B>,IterableW<C>>`	`iterableM()` Promotes this function to a function on Iterables.
`static <A,B,C> F2W<A,B,C>`	`lift(F2<A,B,C> f)` Lifts the function into the fully featured function wrapper
`F2W<List<A>,List<B>,List<C>>`	`listM()` Promotes this function to a function on Lists.
`<Z> F2W<A,B,Z>`	`map(F<C,Z> f)`
`F2W<NonEmptyList<A>,NonEmptyList<B>,NonEmptyList<C>>`	`nelM()` Promotes this function to a function on non-empty lists.
`F2W<Option<A>,Option<B>,Option<C>>`	`optionM()` Promotes this function to a function on Options.
`F2W<Promise<A>,Promise<B>,Promise<C>>`	`promiseM()` Promotes this function to a function on Promises.
`F2W<Set<A>,Set<B>,Set<C>>`	`setM(Ord<C> o)` Promotes this function to a function on Sets.
`F2W<Stream<A>,Stream<B>,Stream<C>>`	`streamM()` Promotes this function to a function on Streams.
`F2W<Tree<A>,Tree<B>,Tree<C>>`	`treeM()` Promotes this function to a function on Trees.
`F1W<P2<A,B>,C>`	`tuple()` Uncurries this function to a function on tuples.
`F2W<Array<A>,Array<B>,Array<C>>`	`zipArrayM()` Promotes this function to zip two arrays, applying the function lock-step over both Arrays.
`F2W<java.lang.Iterable<A>,java.lang.Iterable<B>,java.lang.Iterable<C>>`	`zipIterableM()` Promotes this function to zip two iterables, applying the function lock-step over both iterables.
`F2W<List<A>,List<B>,List<C>>`	`zipListM()` Promotes this function to zip two lists, applying the function lock-step over both lists.
`F2W<NonEmptyList<A>,NonEmptyList<B>,NonEmptyList<C>>`	`zipNelM()` Promotes this function to zip two non-empty lists, applying the function lock-step over both lists.
`F2W<Set<A>,Set<B>,Set<C>>`	`zipSetM(Ord<C> o)` Promotes this function to zip two sets, applying the function lock-step over both sets.
`F2W<Stream<A>,Stream<B>,Stream<C>>`	`zipStreamM()` Promotes this function to zip two streams, applying the function lock-step over both streams.
`F2W<Tree<A>,Tree<B>,Tree<C>>`	`zipTreeM()` Promotes this function to zip two trees, applying the function lock-step over both trees.
`F2W<TreeZipper<A>,TreeZipper<B>,TreeZipper<C>>`	`zipTreeZipperM()` Promotes this function to zip two TreeZippers, applying the function lock-step over both zippers in all directions.
`F2W<Zipper<A>,Zipper<B>,Zipper<C>>`	`zipZipperM()` Promotes this function to zip two zippers, applying the function lock-step over both zippers in both directions.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface fj.F2
f

- Constructor Detail
 - F2W
```
public F2W()
```
- Method Detail
 - f
```
public F1W<B,C> f(A a)
```
 Partial application.
 
 Parameters:
 
 a - The A to which to apply this function.
 
 Returns:
 
 The function partially applied to the given argument.
 - curry
```
public F1W<A,F<B,C>> curry()
```
 Curries this wrapped function to a wrapped function of arity-1 that returns another wrapped function.
 
 Returns:
 
 a wrapped function of arity-1 that returns another wrapped function.
 - flip
```
public F2W<B,A,C> flip()
```
 Flips the arguments of this function.
 
 Returns:
 
 A new function with the arguments of this function flipped.
 - tuple
```
public F1W<P2<A,B>,C> tuple()
```
 Uncurries this function to a function on tuples.
 
 Returns:
 
 A new function that calls this function with the elements of a given tuple.
 - arrayM
```
public F2W<Array<A>,Array,Array<C>> arrayM()
```
 Promotes this function to a function on Arrays.
 
 Returns:
 
 This function promoted to transform Arrays.
 - promiseM
```
public F2W<Promise<A>,Promise,Promise<C>> promiseM()
```
 Promotes this function to a function on Promises.
 
 Returns:
 
 This function promoted to transform Promises.
 - iterableM
```
public F2W<java.lang.Iterable<A>,java.lang.Iterable,IterableW<C>> iterableM()
```
 Promotes this function to a function on Iterables.
 
 Returns:
 
 This function promoted to transform Iterables.
 - listM
```
public F2W<List<A>,List,List<C>> listM()
```
 Promotes this function to a function on Lists.
 
 Returns:
 
 This function promoted to transform Lists.
 - nelM
```
public F2W<NonEmptyList<A>,NonEmptyList,NonEmptyList<C>> nelM()
```
 Promotes this function to a function on non-empty lists.
 
 Returns:
 
 This function promoted to transform non-empty lists.
 - optionM
```
public F2W<Option<A>,Option,Option<C>> optionM()
```
 Promotes this function to a function on Options.
 
 Returns:
 
 This function promoted to transform Options.
 - setM
```
public F2W<Set<A>,Set,Set<C>> setM(Ord<C> o)
```
 Promotes this function to a function on Sets.
 
 Parameters:
 
 o - An ordering for the result of the promoted function.
 
 Returns:
 
 This function promoted to transform Sets.
 - streamM
```
public F2W<Stream<A>,Stream,Stream<C>> streamM()
```
 Promotes this function to a function on Streams.
 
 Returns:
 
 This function promoted to transform Streams.
 - treeM
```
public F2W<Tree<A>,Tree,Tree<C>> treeM()
```
 Promotes this function to a function on Trees.
 
 Returns:
 
 This function promoted to transform Trees.
 - zipArrayM
```
public F2W<Array<A>,Array,Array<C>> zipArrayM()
```
 Promotes this function to zip two arrays, applying the function lock-step over both Arrays.
 
 Returns:
 
 A function that zips two arrays with this function.
 - zipIterableM
```
public F2W<java.lang.Iterable<A>,java.lang.Iterable,java.lang.Iterable<C>> zipIterableM()
```
 Promotes this function to zip two iterables, applying the function lock-step over both iterables.
 
 Returns:
 
 A function that zips two iterables with this function.
 - zipListM
```
public F2W<List<A>,List,List<C>> zipListM()
```
 Promotes this function to zip two lists, applying the function lock-step over both lists.
 
 Returns:
 
 A function that zips two lists with this function.
 - zipStreamM
```
public F2W<Stream<A>,Stream,Stream<C>> zipStreamM()
```
 Promotes this function to zip two streams, applying the function lock-step over both streams.
 
 Returns:
 
 A function that zips two streams with this function.
 - zipNelM
```
public F2W<NonEmptyList<A>,NonEmptyList,NonEmptyList<C>> zipNelM()
```
 Promotes this function to zip two non-empty lists, applying the function lock-step over both lists.
 
 Returns:
 
 A function that zips two non-empty lists with this function.
 - zipSetM
```
public F2W<Set<A>,Set,Set<C>> zipSetM(Ord<C> o)
```
 Promotes this function to zip two sets, applying the function lock-step over both sets.
 
 Parameters:
 
 o - An ordering for the resulting set.
 
 Returns:
 
 A function that zips two sets with this function.
 - zipTreeM
```
public F2W<Tree<A>,Tree,Tree<C>> zipTreeM()
```
 Promotes this function to zip two trees, applying the function lock-step over both trees. The structure of the resulting tree is the structural intersection of the two trees.
 
 Returns:
 
 A function that zips two trees with this function.
 - zipZipperM
```
public F2W<Zipper<A>,Zipper,Zipper<C>> zipZipperM()
```
 Promotes this function to zip two zippers, applying the function lock-step over both zippers in both directions. The structure of the resulting zipper is the structural intersection of the two zippers.
 
 Returns:
 
 A function that zips two zippers with this function.
 - zipTreeZipperM
```
public F2W<TreeZipper<A>,TreeZipper,TreeZipper<C>> zipTreeZipperM()
```
 Promotes this function to zip two TreeZippers, applying the function lock-step over both zippers in all directions. The structure of the resulting TreeZipper is the structural intersection of the two TreeZippers.
 
 Returns:
 
 A function that zips two TreeZippers with this function.
 - contramapFirst
```
public <Z> F2W<Z,B,C> contramapFirst(F<Z,A> f)
```
 - contramapSecond
```
public <Z> F2W<A,Z,C> contramapSecond(F<Z,B> f)
```
 - contramap
```
public <X,Y> F2W<X,Y,C> contramap(F<X,A> f,
 F<Y,B> g)
```
 - map
```
public <Z> F2W<A,B,Z> map(F<C,Z> f)
```
 - lift
```
public static <A,B,C> F2W<A,B,C> lift(F2<A,B,C> f)
```
 Lifts the function into the fully featured function wrapper

Class F2W<A,B,C>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface fj.F2

Constructor Detail

F2W

Method Detail

f

curry

flip

tuple

arrayM

promiseM

iterableM

listM

nelM

optionM

setM

streamM

treeM

zipArrayM

zipIterableM

zipListM

zipStreamM

zipNelM

zipSetM

zipTreeM

zipZipperM

zipTreeZipperM

contramapFirst

contramapSecond

contramap

map

lift