ternary.ObjObjObjToDbl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of functions-ternary-core Show documentation
Show all versions of functions-ternary-core Show documentation
Provides functional interfaces for the most commonly used two-argument functions
package net.mintern.functions.ternary;
/**
* An operation of type {@code (T, U, V) -> double}.
*
* @param the type of argument 1
* @param the type of argument 2
* @param the type of argument 3
*/
@FunctionalInterface
public interface ObjObjObjToDbl extends
net.mintern.functions.ternary.checked.ObjObjObjToDblE {
/**
* Returns a wrapped version of {@code f} that uses {@code toRuntime} to convert any checked
* {@code Exception} to a {@code RuntimeException}.
*
* @param the type of argument 1
* @param the type of argument 2
* @param the type of argument 3
* @param the {@code Exception} type that the operation may throw
* @param toRuntime if a checked exception is thrown from
* {@link net.mintern.functions.ternary.checked.ObjObjObjToDblE#call}, then this function
* is called in in order to convert it to a {@code RuntimeException}
* @param f the operation to wrap
* @return a wrapped version of {@code f} that does not throw checked exceptions
*/
@SuppressWarnings("unchecked")
static ObjObjObjToDbl unchecked(
java.util.function.Function toRuntime,
net.mintern.functions.ternary.checked.ObjObjObjToDblE f) {
return (t, u, v) -> {
try {
return f.call(t, u, v);
} catch (RuntimeException e) {
throw e;
} catch (Exception e) {
throw toRuntime.apply((E) e);
}
};
}
/**
* Returns a wrapped version of {@code f} that wraps any checked {@code Exception} with a
* {@code RuntimeException}.
*
* @param the type of argument 1
* @param the type of argument 2
* @param the type of argument 3
* @param the {@code Exception} type that the operation may throw
* @param f the operation to wrap
* @return a wrapped version of {@code f} that does not throw checked exceptions
*/
static ObjObjObjToDbl unchecked(
net.mintern.functions.ternary.checked.ObjObjObjToDblE f) {
return unchecked(RuntimeException::new, f);
}
/**
* Returns a wrapped version of {@code f} that wraps any {@code IOException} with an
* {@link java.io.UncheckedIOException}.
*
* @param the type of argument 1
* @param the type of argument 2
* @param the type of argument 3
* @param the {@code Exception} type that the operation may throw
* @param f the operation to wrap
* @return a wrapped version of {@code f} that throws {@code UncheckedIOException} instead of
* {@code IOException}
*/
static ObjObjObjToDbl uncheckedIO(
net.mintern.functions.ternary.checked.ObjObjObjToDblE f) {
return unchecked(java.io.UncheckedIOException::new, f);
}
/**
* Binds {@code (t)} to the beginning of {@code f}, returning a new function
* of type {@code (U, V) -> double}.
*
* @param the type of argument 1
* @param the type of argument 2
* @param the type of argument 3
* @param f the unbound function
* @param t argument 1
* @return a new function {@code (U u, V v) -> double} that calls
* {@code f.call(t, u, v)} and returns the result.
*/
static net.mintern.functions.binary.ObjObjToDbl
bind(ObjObjObjToDbl f, T t) {
return (u, v) -> f.call(t, u, v);
}
/**
* Binds {@code (t)} to the beginning of {@code this}, returning a new function
* of type {@code (U, V) -> double}.
*
* @param t argument 1
* @return a new function {@code (U u, V v) -> double} that calls
* {@code this.call(t, u, v)} and returns the result.
*/
@Override
default net.mintern.functions.binary.ObjObjToDbl bind(T t) {
return ObjObjObjToDbl.bind(this, t);
}
/**
* Binds {@code (u, v)} to the end of {@code f}, returning a new function
* of type {@code (T) -> double}.
*
* @param the type of argument 1
* @param the type of argument 2
* @param the type of argument 3
* @param f the unbound function
* @param u argument 2
* @param v argument 3
* @return a new function {@code (T t) -> double} that calls
* {@code f.call(t, u, v)} and returns the result.
*/
static net.mintern.functions.unary.ObjToDbl
rbind(ObjObjObjToDbl f, U u, V v) {
return (t) -> f.call(t, u, v);
}
/**
* Binds {@code (u, v)} to the end of {@code this}, returning a new function
* of type {@code (T) -> double}.
*
* @param u argument 2
* @param v argument 3
* @return a new function {@code (T t) -> double} that calls
* {@code this.call(t, u, v)} and returns the result.
*/
@Override
default net.mintern.functions.unary.ObjToDbl rbind(U u, V v) {
return ObjObjObjToDbl.rbind(this, u, v);
}
/**
* Binds {@code (t, u)} to the beginning of {@code f}, returning a new function
* of type {@code (V) -> double}.
*
* @param the type of argument 1
* @param the type of argument 2
* @param the type of argument 3
* @param f the unbound function
* @param t argument 1
* @param u argument 2
* @return a new function {@code (V v) -> double} that calls
* {@code f.call(t, u, v)} and returns the result.
*/
static net.mintern.functions.unary.ObjToDbl
bind(ObjObjObjToDbl f, T t, U u) {
return (v) -> f.call(t, u, v);
}
/**
* Binds {@code (t, u)} to the beginning of {@code this}, returning a new function
* of type {@code (V) -> double}.
*
* @param t argument 1
* @param u argument 2
* @return a new function {@code (V v) -> double} that calls
* {@code this.call(t, u, v)} and returns the result.
*/
@Override
default net.mintern.functions.unary.ObjToDbl bind(T t, U u) {
return ObjObjObjToDbl.bind(this, t, u);
}
/**
* Binds {@code (v)} to the end of {@code f}, returning a new function
* of type {@code (T, U) -> double}.
*
* @param the type of argument 1
* @param the type of argument 2
* @param the type of argument 3
* @param f the unbound function
* @param v argument 3
* @return a new function {@code (T t, U u) -> double} that calls
* {@code f.call(t, u, v)} and returns the result.
*/
static net.mintern.functions.binary.ObjObjToDbl
rbind(ObjObjObjToDbl f, V v) {
return (t, u) -> f.call(t, u, v);
}
/**
* Binds {@code (v)} to the end of {@code this}, returning a new function
* of type {@code (T, U) -> double}.
*
* @param v argument 3
* @return a new function {@code (T t, U u) -> double} that calls
* {@code this.call(t, u, v)} and returns the result.
*/
@Override
default net.mintern.functions.binary.ObjObjToDbl rbind(V v) {
return ObjObjObjToDbl.rbind(this, v);
}
/**
* Binds {@code (t, u, v)} to {@code f}, returning a new function
* of type {@code () -> double}.
*
* @param the type of argument 1
* @param the type of argument 2
* @param the type of argument 3
* @param f the unbound function
* @param t argument 1
* @param u argument 2
* @param v argument 3
* @return a new function {@code () -> double} that calls
* {@code f.call(t, u, v)} and returns the result.
*/
static net.mintern.functions.nullary.NilToDbl
bind(ObjObjObjToDbl f, T t, U u, V v) {
return () -> f.call(t, u, v);
}
/**
* Binds {@code (t, u, v)} to {@code this}, returning a new function
* of type {@code () -> double}.
*
* @param t argument 1
* @param u argument 2
* @param v argument 3
* @return a new function {@code () -> double} that calls
* {@code this.call(t, u, v)} and returns the result.
*/
@Override
default net.mintern.functions.nullary.NilToDbl bind(T t, U u, V v) {
return ObjObjObjToDbl.bind(this, t, u, v);
}
}