net.mintern.functions.binary.IntIntToDbl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of functions-binary-core Show documentation
Provides functional interfaces for the most commonly used two-argument functions
The newest version!
package net.mintern.functions.binary;

/**
 * An operation of type {@code (int, int) -> double}.
 *
 */
@FunctionalInterface
public interface IntIntToDbl extends
        net.mintern.functions.binary.checked.IntIntToDblE {

    /**
     * Returns a wrapped version of {@code f} that uses {@code toRuntime} to convert any checked
     * {@code Exception} to a {@code RuntimeException}.
     *
     * @param  the {@code Exception} type that the operation may throw
     * @param toRuntime if a checked exception is thrown from
     *      {@link net.mintern.functions.binary.checked.IntIntToDblE#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  IntIntToDbl unchecked(
            java.util.function.Function toRuntime,
            net.mintern.functions.binary.checked.IntIntToDblE f) {
        return (i1, i2) -> {
            try {
                return f.call(i1, i2);
            } 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 {@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  IntIntToDbl unchecked(
            net.mintern.functions.binary.checked.IntIntToDblE 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 {@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  IntIntToDbl uncheckedIO(
            net.mintern.functions.binary.checked.IntIntToDblE f) {
        return unchecked(java.io.UncheckedIOException::new, f);
    }

    /**
     * Binds {@code (i1)} to the beginning of {@code f}, returning a new function
     * of type {@code (int) -> double}.
     *
     * @param f the unbound function
     * @param i1 argument 1
     * @return a new function {@code (int i2) -> double} that calls
     *      {@code f.call(i1, i2)} and returns the result.
     */
    static  net.mintern.functions.unary.IntToDbl
    bind(IntIntToDbl f, int i1) {
        return (i2) -> f.call(i1, i2);
    }

    /**
     * Binds {@code (i1)} to the beginning of {@code this}, returning a new function
     * of type {@code (int) -> double}.
     *
     * @param i1 argument 1
     * @return a new function {@code (int i2) -> double} that calls
     *      {@code this.call(i1, i2)} and returns the result.
     */
    @Override
    default net.mintern.functions.unary.IntToDbl bind(int i1) {
        return IntIntToDbl.bind(this, i1);
    }

    /**
     * Binds {@code (i2)} to the end of {@code f}, returning a new function
     * of type {@code (int) -> double}.
     *
     * @param f the unbound function
     * @param i2 argument 2
     * @return a new function {@code (int i1) -> double} that calls
     *      {@code f.call(i1, i2)} and returns the result.
     */
    static  net.mintern.functions.unary.IntToDbl
    rbind(IntIntToDbl f, int i2) {
        return (i1) -> f.call(i1, i2);
    }

    /**
     * Binds {@code (i2)} to the end of {@code this}, returning a new function
     * of type {@code (int) -> double}.
     *
     * @param i2 argument 2
     * @return a new function {@code (int i1) -> double} that calls
     *      {@code this.call(i1, i2)} and returns the result.
     */
    @Override
    default net.mintern.functions.unary.IntToDbl rbind(int i2) {
        return IntIntToDbl.rbind(this, i2);
    }

    /**
     * Binds {@code (i1, i2)} to {@code f}, returning a new function
     * of type {@code () -> double}.
     *
     * @param f the unbound function
     * @param i1 argument 1
     * @param i2 argument 2
     * @return a new function {@code () -> double} that calls
     *      {@code f.call(i1, i2)} and returns the result.
     */
    static  net.mintern.functions.nullary.NilToDbl
    bind(IntIntToDbl f, int i1, int i2) {
        return () -> f.call(i1, i2);
    }

    /**
     * Binds {@code (i1, i2)} to {@code this}, returning a new function
     * of type {@code () -> double}.
     *
     * @param i1 argument 1
     * @param i2 argument 2
     * @return a new function {@code () -> double} that calls
     *      {@code this.call(i1, i2)} and returns the result.
     */
    @Override
    default net.mintern.functions.nullary.NilToDbl bind(int i1, int i2) {
        return IntIntToDbl.bind(this, i1, i2);
    }
}