org.lenskit.util

Interface InvertibleFunction<F,T>

All Superinterfaces:

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

All Known Subinterfaces:

VectorTransformation

public interface InvertibleFunction<F,T>
extends Function<F,T>

A function for which an inverse is available.

Method Summary

Modifier and Type	Method and Description
F	unapply(T input) Returns the result of applying the inverse of this function to input.

Methods inherited from interface com.google.common.base.Function

apply, equals

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Method Detail

unapply

F unapply(T input)

Returns the result of applying the inverse of this function to input.

The following should generally hold:

F object = value;
T result = function.apply(object);
F inverse = function.unapply(result);
assert inverse.equals(object);

Parameters:

input - The input value.

Returns:

The inverse of the input