uk.co.strangeskies.function

Interface InvertibleFunction<T,R>

Type Parameters:

T - Operand type.

R - Result type.

All Superinterfaces:

java.util.function.Function<T,R>

public interface InvertibleFunction<T,R>
extends java.util.function.Function<T,R>

Describes a function from F to T. A function should be stateless.

Method Summary

Modifier and Type	Method and Description
static <T,I,R> InvertibleFunction<T,R>	compose(InvertibleFunction<T,I> first, InvertibleFunction<I,R> second)
InvertibleFunction<R,T>	getInverse() This returns the mathematical inverse of the receiving function.
static <T,R> InvertibleFunction<T,R>	over(java.util.function.Function<? super T,? extends R> function, java.util.function.Function<? super R,? extends T> reverse)

Methods inherited from interface java.util.function.Function

andThen, apply, compose, identity

Method Detail

getInverse

InvertibleFunction<R,T> getInverse()

This returns the mathematical inverse of the receiving function.

Returns:

A new Invertible function performing the inverse operation.

over

static <T,R> InvertibleFunction<T,R> over(java.util.function.Function<? super T,? extends R> function,
                                          java.util.function.Function<? super R,? extends T> reverse)

Type Parameters:

T - The operand type of the forward function, and the result type of its reverse.

R - The result type of the forward function, and the operand type of its reverse.

Parameters:

function - The function in forward direction.

reverse - The reverse of the function.

Returns:

An invertible function using the two given functions.

compose

static <T,I,R> InvertibleFunction<T,R> compose(InvertibleFunction<T,I> first,
                                               InvertibleFunction<I,R> second)

Type Parameters:

T - The operand type of the first function.

I - An intermediate type which the result type of the first function can be assigned to, and which can assign to the operand type of the second function.

R - The result type of the second function.

Parameters:

first - The first function to compose.

second - The second function to compose.

Returns:

Composition of two invertible functions into a single invertible function.