com.jnape.palatable.lambda.functions

Interface Fn5<A,B,C,D,E,F>

Type Parameters:

A - The first argument type

B - The second argument type

C - The third argument type

D - The fourth argument type

E - The fifth argument type

F - The return type

All Superinterfaces:

Applicative<Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>,Fn1<A,?>>, Cartesian<A,Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>,Fn1<?,?>>, Cocartesian<A,Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>,Fn1<?,?>>, Contravariant<A,Profunctor<?,Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>,Fn1<?,?>>>, Fn1<A,Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>>, Fn2<A,B,Fn1<C,Fn1<D,Fn1<E,F>>>>, Fn3<A,B,C,Fn1<D,Fn1<E,F>>>, Fn4<A,B,C,D,Fn1<E,F>>, Functor<Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>,Fn1<A,?>>, Monad<Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>,Fn1<A,?>>, MonadReader<A,Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>,Fn1<A,?>>, MonadRec<Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>,Fn1<A,?>>, MonadWriter<A,Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>,Fn1<A,?>>, Profunctor<A,Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>,Fn1<?,?>>

All Known Subinterfaces:

Fn6<A,B,C,D,E,F,G>, Fn7<A,B,C,D,E,F,G,H>, Fn8<A,B,C,D,E,F,G,H,I>

All Known Implementing Classes:

LiftA4, LiftA5, LiftA6, LiftA7

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Fn5<A,B,C,D,E,F>
extends Fn4<A,B,C,D,Fn1<E,F>>

A function taking five arguments. Defined in terms of Fn4, so similarly auto-curried.

See Also:

Fn4

Method Summary

Modifier and Type	Method and Description
default Fn4<B,C,D,E,F>	apply(A a) Partially apply this function by taking its first argument.
default Fn3<C,D,E,F>	apply(A a, B b) Partially apply this function by taking its first two arguments.
default Fn2<D,E,F>	apply(A a, B b, C c) Partially apply this function by taking its first three arguments.
default Fn1<E,F>	apply(A a, B b, C c, D d) Partially apply this function by taking its first four arguments.
default F	apply(A a, B b, C c, D d, E e) Invoke this function with the given arguments.
default Fn1<E,F>	checkedApply(A a, B b, C c, D d)
F	checkedApply(A a, B b, C c, D d, E e)
default <Y,Z> Fn6<Y,Z,B,C,D,E,F>	compose(Fn2<? super Y,? super Z,? extends A> before) Right-to-left composition between different arity functions.
default <Z> Fn5<Z,B,C,D,E,F>	contraMap(Fn1<? super Z,? extends A> fn) Contravariantly map A <- B.
default <Z> Fn5<Z,B,C,D,E,F>	diMapL(Fn1<? super Z,? extends A> fn) Contravariantly map over the argument to this function, producing a function that takes the new argument type, and produces the same result.
default <G> Fn5<A,B,C,D,E,F>	discardR(Applicative<G,Fn1<A,?>> appB) Sequence both this Applicative and appB, discarding appB's result and returning this Applicative.
default Fn5<B,A,C,D,E,F>	flip() Flip the order of the first two arguments.
static <A,B,C,D,E,F> Fn5<A,B,C,D,E,F>	fn5(Fn1<A,Fn4<B,C,D,E,F>> curriedFn1) Static factory method for wrapping a curried Fn1 in an Fn5.
static <A,B,C,D,E,F> Fn5<A,B,C,D,E,F>	fn5(Fn2<A,B,Fn3<C,D,E,F>> curriedFn2) Static factory method for wrapping a curried Fn2 in an Fn5.
static <A,B,C,D,E,F> Fn5<A,B,C,D,E,F>	fn5(Fn3<A,B,C,Fn2<D,E,F>> curriedFn3) Static factory method for wrapping a curried Fn3 in an Fn5.
static <A,B,C,D,E,F> Fn5<A,B,C,D,E,F>	fn5(Fn4<A,B,C,D,Fn1<E,F>> curriedFn4) Static factory method for wrapping a curried Fn4 in an Fn5.
static <A,B,C,D,E,F> Fn5<A,B,C,D,E,F>	fn5(Fn5<A,B,C,D,E,F> fn) Static factory method for coercing a lambda to an Fn5.
default Fn4<? super Product2<? extends A,? extends B>,C,D,E,F>	uncurry() Returns an Fn4 that takes the first two arguments as a Product2<A, B> and the remaining arguments.
default <Z> Fn6<Z,A,B,C,D,E,F>	widen() Widen this function's argument list by prepending an ignored argument of any type to the front.

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

checkedApply, fn4, fn4, fn4, fn4

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

checkedApply, fn3, fn3, fn3

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

checkedApply, curried, curry, fn2, fromBiFunction, toBiFunction

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

andThen, carry, cartesian, censor, choose, cocartesian, diMap, diMapR, discardL, flatMap, fmap, fn1, fromFunction, lazyZip, listens, local, pure, pureFn1, thunk, toFunction, trampolineM, zip, zip

Methods inherited from interface com.jnape.palatable.lambda.monad.Monad

join

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

coerce

Method Detail

checkedApply

F checkedApply(A a,
               B b,
               C c,
               D d,
               E e)
        throws Throwable

Throws:

Throwable

apply

default F apply(A a,
                B b,
                C c,
                D d,
                E e)

Invoke this function with the given arguments.

Parameters:

a - the first argument

b - the second argument

c - the third argument

d - the fourth argument

e - the fifth argument

Returns:

the result of the function application

checkedApply

default Fn1<E,F> checkedApply(A a,
                              B b,
                              C c,
                              D d)
                       throws Throwable

Specified by:

checkedApply in interface Fn4<A,B,C,D,Fn1<E,F>>

Throws:

Throwable

widen

default <Z> Fn6<Z,A,B,C,D,E,F> widen()

Widen this function's argument list by prepending an ignored argument of any type to the front.

Specified by:

widen in interface Fn1<A,Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>>

Specified by:

widen in interface Fn2<A,B,Fn1<C,Fn1<D,Fn1<E,F>>>>

Specified by:

widen in interface Fn3<A,B,C,Fn1<D,Fn1<E,F>>>

Specified by:

widen in interface Fn4<A,B,C,D,Fn1<E,F>>

Type Parameters:

Z - the new first argument type

Returns:

the widened function

apply

default Fn4<B,C,D,E,F> apply(A a)

Partially apply this function by taking its first argument.

Specified by:

apply in interface Fn1<A,Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>>

Specified by:

apply in interface Fn2<A,B,Fn1<C,Fn1<D,Fn1<E,F>>>>

Specified by:

apply in interface Fn3<A,B,C,Fn1<D,Fn1<E,F>>>

Specified by:

apply in interface Fn4<A,B,C,D,Fn1<E,F>>

Parameters:

a - the first argument

Returns:

an Fn5 that takes the remaining arguments and returns the result

apply

default Fn3<C,D,E,F> apply(A a,
                           B b)

Partially apply this function by taking its first two arguments.

Specified by:

apply in interface Fn2<A,B,Fn1<C,Fn1<D,Fn1<E,F>>>>

Specified by:

apply in interface Fn3<A,B,C,Fn1<D,Fn1<E,F>>>

Specified by:

apply in interface Fn4<A,B,C,D,Fn1<E,F>>

Parameters:

a - the first argument

b - the second argument

Returns:

an Fn3 that takes the remaining arguments and returns the result

apply

default Fn2<D,E,F> apply(A a,
                         B b,
                         C c)

Partially apply this function by taking its first three arguments.

Specified by:

apply in interface Fn3<A,B,C,Fn1<D,Fn1<E,F>>>

Specified by:

apply in interface Fn4<A,B,C,D,Fn1<E,F>>

Parameters:

a - the first argument

b - the second argument

c - the third argument

Returns:

an Fn2 that takes remaining arguments and returns the result

apply

default Fn1<E,F> apply(A a,
                       B b,
                       C c,
                       D d)

Partially apply this function by taking its first four arguments.

Specified by:

apply in interface Fn4<A,B,C,D,Fn1<E,F>>

Parameters:

a - the first argument

b - the second argument

c - the third argument

d - the fourth argument

Returns:

an Fn1 that takes the remaining argument and returns the result

flip

default Fn5<B,A,C,D,E,F> flip()

Flip the order of the first two arguments.

Specified by:

flip in interface Fn2<A,B,Fn1<C,Fn1<D,Fn1<E,F>>>>

Specified by:

flip in interface Fn3<A,B,C,Fn1<D,Fn1<E,F>>>

Specified by:

flip in interface Fn4<A,B,C,D,Fn1<E,F>>

Returns:

an Fn5 that takes the first and second arguments in reversed order

uncurry

default Fn4<? super Product2<? extends A,? extends B>,C,D,E,F> uncurry()

Returns an Fn4 that takes the first two arguments as a Product2<A, B> and the remaining arguments.

Specified by:

uncurry in interface Fn2<A,B,Fn1<C,Fn1<D,Fn1<E,F>>>>

Specified by:

uncurry in interface Fn3<A,B,C,Fn1<D,Fn1<E,F>>>

Specified by:

uncurry in interface Fn4<A,B,C,D,Fn1<E,F>>

Returns:

an Fn4 taking a Product2 and the remaining arguments

discardR

default <G> Fn5<A,B,C,D,E,F> discardR(Applicative<G,Fn1<A,?>> appB)

Description copied from interface: Fn2

Sequence both this Applicative and appB, discarding appB's result and returning this Applicative. This is generally useful for sequentially performing side-effects.

Specified by:

discardR in interface Applicative<Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>,Fn1<A,?>>

Specified by:

discardR in interface Fn1<A,Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>>

Specified by:

discardR in interface Fn2<A,B,Fn1<C,Fn1<D,Fn1<E,F>>>>

Specified by:

discardR in interface Fn3<A,B,C,Fn1<D,Fn1<E,F>>>

Specified by:

discardR in interface Fn4<A,B,C,D,Fn1<E,F>>

Specified by:

discardR in interface Monad<Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>,Fn1<A,?>>

Specified by:

discardR in interface MonadReader<A,Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>,Fn1<A,?>>

Specified by:

discardR in interface MonadRec<Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>,Fn1<A,?>>

Specified by:

discardR in interface MonadWriter<A,Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>,Fn1<A,?>>

Type Parameters:

G - the type of appB's parameter

Parameters:

appB - the other Applicative

Returns:

this Applicative

diMapL

default <Z> Fn5<Z,B,C,D,E,F> diMapL(Fn1<? super Z,? extends A> fn)

Description copied from interface: Fn2

Contravariantly map over the argument to this function, producing a function that takes the new argument type, and produces the same result.

Specified by:

diMapL in interface Cartesian<A,Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>,Fn1<?,?>>

Specified by:

diMapL in interface Cocartesian<A,Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>,Fn1<?,?>>

Specified by:

diMapL in interface Fn1<A,Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>>

Specified by:

diMapL in interface Fn2<A,B,Fn1<C,Fn1<D,Fn1<E,F>>>>

Specified by:

diMapL in interface Fn3<A,B,C,Fn1<D,Fn1<E,F>>>

Specified by:

diMapL in interface Fn4<A,B,C,D,Fn1<E,F>>

Specified by:

diMapL in interface Profunctor<A,Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>,Fn1<?,?>>

Type Parameters:

Z - the new argument type

Parameters:

fn - the contravariant argument mapping function

Returns:

an Fn1<Z, B>

contraMap

default <Z> Fn5<Z,B,C,D,E,F> contraMap(Fn1<? super Z,? extends A> fn)

Description copied from interface: Fn2

Contravariantly map A <- B.

Specified by:

contraMap in interface Cartesian<A,Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>,Fn1<?,?>>

Specified by:

contraMap in interface Cocartesian<A,Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>,Fn1<?,?>>

Specified by:

contraMap in interface Contravariant<A,Profunctor<?,Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>,Fn1<?,?>>>

Specified by:

contraMap in interface Fn1<A,Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>>

Specified by:

contraMap in interface Fn2<A,B,Fn1<C,Fn1<D,Fn1<E,F>>>>

Specified by:

contraMap in interface Fn3<A,B,C,Fn1<D,Fn1<E,F>>>

Specified by:

contraMap in interface Fn4<A,B,C,D,Fn1<E,F>>

Specified by:

contraMap in interface Profunctor<A,Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>,Fn1<?,?>>

Type Parameters:

Z - the new parameter type

Parameters:

fn - the mapping function

Returns:

the mapped Contravariant functor instance

compose

default <Y,Z> Fn6<Y,Z,B,C,D,E,F> compose(Fn2<? super Y,? super Z,? extends A> before)

Description copied from interface: Fn2

Right-to-left composition between different arity functions. Preserves highest arity in the return type.

Specified by:

compose in interface Fn1<A,Fn1<B,Fn1<C,Fn1<D,Fn1<E,F>>>>>

Specified by:

compose in interface Fn2<A,B,Fn1<C,Fn1<D,Fn1<E,F>>>>

Specified by:

compose in interface Fn3<A,B,C,Fn1<D,Fn1<E,F>>>

Specified by:

compose in interface Fn4<A,B,C,D,Fn1<E,F>>

Type Parameters:

Y - the resulting function's first argument type

Z - the resulting function's second argument type

Parameters:

before - the function to pass its return value to this function's input

Returns:

an Fn2<Y, Z, B>

fn5

static <A,B,C,D,E,F> Fn5<A,B,C,D,E,F> fn5(Fn1<A,Fn4<B,C,D,E,F>> curriedFn1)

Static factory method for wrapping a curried Fn1 in an Fn5.

Type Parameters:

A - the first input argument type

B - the second input argument type

C - the third input argument type

D - the fourth input argument type

E - the fifth input argument type

F - the output type

Parameters:

curriedFn1 - the curried fn1 to adapt

Returns:

the Fn5

fn5

static <A,B,C,D,E,F> Fn5<A,B,C,D,E,F> fn5(Fn2<A,B,Fn3<C,D,E,F>> curriedFn2)

Static factory method for wrapping a curried Fn2 in an Fn5.

Type Parameters:

A - the first input argument type

B - the second input argument type

C - the third input argument type

D - the fourth input argument type

E - the fifth input argument type

F - the output type

Parameters:

curriedFn2 - the curried fn2 to adapt

Returns:

the Fn5

fn5

static <A,B,C,D,E,F> Fn5<A,B,C,D,E,F> fn5(Fn3<A,B,C,Fn2<D,E,F>> curriedFn3)

Static factory method for wrapping a curried Fn3 in an Fn5.

Type Parameters:

A - the first input argument type

B - the second input argument type

C - the third input argument type

D - the fourth input argument type

E - the fifth input argument type

F - the output type

Parameters:

curriedFn3 - the curried fn3 to adapt

Returns:

the Fn5

fn5

static <A,B,C,D,E,F> Fn5<A,B,C,D,E,F> fn5(Fn4<A,B,C,D,Fn1<E,F>> curriedFn4)

Static factory method for wrapping a curried Fn4 in an Fn5.

Type Parameters:

A - the first input argument type

B - the second input argument type

C - the third input argument type

D - the fourth input argument type

E - the fifth input argument type

F - the output type

Parameters:

curriedFn4 - the curried fn4 to adapt

Returns:

the Fn5

fn5

static <A,B,C,D,E,F> Fn5<A,B,C,D,E,F> fn5(Fn5<A,B,C,D,E,F> fn)

Static factory method for coercing a lambda to an Fn5.

Type Parameters:

A - the first input argument type

B - the second input argument type

C - the third input argument type

D - the fourth input argument type

E - the fifth input argument type

F - the output type

Parameters:

fn - the lambda to coerce

Returns:

the Fn5