F2Functions (core 4.6 API)

java.lang.Object
- fj.F2Functions

public final class F2Functions
extends java.lang.Object

Created by MarkPerry on 6/04/2014.

Method Summary

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

- Method Detail
 - f
```
public static <A,B,C> F<B,C> f(F2<A,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 static <A,B,C> F<A,F<B,C>> curry(F2<A,B,C> f)
```
 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 static <A,B,C> F2<B,A,C> flip(F2<A,B,C> f)
```
 Flips the arguments of this function.
 
 Returns:
 
 A new function with the arguments of this function flipped.
 - tuple
```
public static <A,B,C> F<P2<A,B>,C> tuple(F2<A,B,C> f)
```
 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 static <A,B,C> F2<Array<A>,Array,Array<C>> arrayM(F2<A,B,C> f)
```
 Promotes this function to a function on Arrays.
 
 Returns:
 
 This function promoted to transform Arrays.
 - promiseM
```
public static <A,B,C> F2<Promise<A>,Promise,Promise<C>> promiseM(F2<A,B,C> f)
```
 Promotes this function to a function on Promises.
 
 Returns:
 
 This function promoted to transform Promises.
 - iterableM
```
public static <A,B,C> F2<java.lang.Iterable<A>,java.lang.Iterable,IterableW<C>> iterableM(F2<A,B,C> f)
```
 Promotes this function to a function on Iterables.
 
 Returns:
 
 This function promoted to transform Iterables.
 - listM
```
public static <A,B,C> F2<List<A>,List,List<C>> listM(F2<A,B,C> f)
```
 Promotes this function to a function on Lists.
 
 Returns:
 
 This function promoted to transform Lists.
 - nelM
```
public static <A,B,C> F2<NonEmptyList<A>,NonEmptyList,NonEmptyList<C>> nelM(F2<A,B,C> f)
```
 Promotes this function to a function on non-empty lists.
 
 Returns:
 
 This function promoted to transform non-empty lists.
 - optionM
```
public static <A,B,C> F2<Option<A>,Option,Option<C>> optionM(F2<A,B,C> f)
```
 Promotes this function to a function on Options.
 
 Returns:
 
 This function promoted to transform Options.
 - setM
```
public static <A,B,C> F2<Set<A>,Set,Set<C>> setM(F2<A,B,C> f,
 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 static <A,B,C> F2<Stream<A>,Stream,Stream<C>> streamM(F2<A,B,C> f)
```
 Promotes this function to a function on Streams.
 
 Returns:
 
 This function promoted to transform Streams.
 - treeM
```
public static <A,B,C> F2<Tree<A>,Tree,Tree<C>> treeM(F2<A,B,C> f)
```
 Promotes this function to a function on Trees.
 
 Returns:
 
 This function promoted to transform Trees.
 - zipArrayM
```
public static <A,B,C> F2<Array<A>,Array,Array<C>> zipArrayM(F2<A,B,C> f)
```
 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 static <A,B,C> F2<java.lang.Iterable<A>,java.lang.Iterable,java.lang.Iterable<C>> zipIterableM(F2<A,B,C> f)
```
 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 static <A,B,C> F2<List<A>,List,List<C>> zipListM(F2<A,B,C> f)
```
 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 static <A,B,C> F2<Stream<A>,Stream,Stream<C>> zipStreamM(F2<A,B,C> f)
```
 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 static <A,B,C> F2<NonEmptyList<A>,NonEmptyList,NonEmptyList<C>> zipNelM(F2<A,B,C> f)
```
 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 static <A,B,C> F2<Set<A>,Set,Set<C>> zipSetM(F2<A,B,C> f,
 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 static <A,B,C> F2<Tree<A>,Tree,Tree<C>> zipTreeM(F2<A,B,C> f)
```
 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 static <A,B,C> F2<Zipper<A>,Zipper,Zipper<C>> zipZipperM(F2<A,B,C> f)
```
 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 static <A,B,C> F2<TreeZipper<A>,TreeZipper,TreeZipper<C>> zipTreeZipperM(F2<A,B,C> f)
```
 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 static <A,B,C,Z> F2<Z,B,C> contramapFirst(F2<A,B,C> target,
 F<Z,A> f)
```
 - contramapSecond
```
public static <A,B,C,Z> F2<A,Z,C> contramapSecond(F2<A,B,C> target,
 F<Z,B> f)
```
 - contramap
```
public static <A,B,C,X,Y> F2<X,Y,C> contramap(F2<A,B,C> target,
 F<X,A> f,
 F<Y,B> g)
```
 - map
```
public static <A,B,C,Z> F2<A,B,Z> map(F2<A,B,C> target,
 F<C,Z> f)
```

Class F2Functions

Method Summary

Methods inherited from class java.lang.Object

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