net.mintern.functions.ternary.DblObjDblToInt 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
Provides functional interfaces for the most commonly used two-argument functions
The newest version!
package net.mintern.functions.ternary;

/**
 * An operation of type {@code (double, U, double) -> int}.
 *
 * @param  the type of the argument
 */
@FunctionalInterface
public interface DblObjDblToInt extends
        net.mintern.functions.ternary.checked.DblObjDblToIntE {

    /**
     * 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 2
     * @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.DblObjDblToIntE#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  DblObjDblToInt unchecked(
            java.util.function.Function toRuntime,
            net.mintern.functions.ternary.checked.DblObjDblToIntE f) {
        return (d1, u, d3) -> {
            try {
                return f.call(d1, u, d3);
            } 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 2
     * @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  DblObjDblToInt unchecked(
            net.mintern.functions.ternary.checked.DblObjDblToIntE 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 2
     * @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  DblObjDblToInt uncheckedIO(
            net.mintern.functions.ternary.checked.DblObjDblToIntE f) {
        return unchecked(java.io.UncheckedIOException::new, f);
    }

    /**
     * Binds {@code (d1)} to the beginning of {@code f}, returning a new function
     * of type {@code (U, double) -> int}.
     *
     * @param  the type of the argument
     * @param f the unbound function
     * @param d1 argument 1
     * @return a new function {@code (U u, double d3) -> int} that calls
     *      {@code f.call(d1, u, d3)} and returns the result.
     */
    static  net.mintern.functions.binary.ObjDblToInt
    bind(DblObjDblToInt f, double d1) {
        return (u, d3) -> f.call(d1, u, d3);
    }

    /**
     * Binds {@code (d1)} to the beginning of {@code this}, returning a new function
     * of type {@code (U, double) -> int}.
     *
     * @param d1 argument 1
     * @return a new function {@code (U u, double d3) -> int} that calls
     *      {@code this.call(d1, u, d3)} and returns the result.
     */
    @Override
    default net.mintern.functions.binary.ObjDblToInt bind(double d1) {
        return DblObjDblToInt.bind(this, d1);
    }

    /**
     * Binds {@code (u, d3)} to the end of {@code f}, returning a new function
     * of type {@code (double) -> int}.
     *
     * @param  the type of the argument
     * @param f the unbound function
     * @param u argument 2
     * @param d3 argument 3
     * @return a new function {@code (double d1) -> int} that calls
     *      {@code f.call(d1, u, d3)} and returns the result.
     */
    static  net.mintern.functions.unary.DblToInt
    rbind(DblObjDblToInt f, U u, double d3) {
        return (d1) -> f.call(d1, u, d3);
    }

    /**
     * Binds {@code (u, d3)} to the end of {@code this}, returning a new function
     * of type {@code (double) -> int}.
     *
     * @param u argument 2
     * @param d3 argument 3
     * @return a new function {@code (double d1) -> int} that calls
     *      {@code this.call(d1, u, d3)} and returns the result.
     */
    @Override
    default net.mintern.functions.unary.DblToInt rbind(U u, double d3) {
        return DblObjDblToInt.rbind(this, u, d3);
    }

    /**
     * Binds {@code (d1, u)} to the beginning of {@code f}, returning a new function
     * of type {@code (double) -> int}.
     *
     * @param  the type of the argument
     * @param f the unbound function
     * @param d1 argument 1
     * @param u argument 2
     * @return a new function {@code (double d3) -> int} that calls
     *      {@code f.call(d1, u, d3)} and returns the result.
     */
    static  net.mintern.functions.unary.DblToInt
    bind(DblObjDblToInt f, double d1, U u) {
        return (d3) -> f.call(d1, u, d3);
    }

    /**
     * Binds {@code (d1, u)} to the beginning of {@code this}, returning a new function
     * of type {@code (double) -> int}.
     *
     * @param d1 argument 1
     * @param u argument 2
     * @return a new function {@code (double d3) -> int} that calls
     *      {@code this.call(d1, u, d3)} and returns the result.
     */
    @Override
    default net.mintern.functions.unary.DblToInt bind(double d1, U u) {
        return DblObjDblToInt.bind(this, d1, u);
    }

    /**
     * Binds {@code (d3)} to the end of {@code f}, returning a new function
     * of type {@code (double, U) -> int}.
     *
     * @param  the type of the argument
     * @param f the unbound function
     * @param d3 argument 3
     * @return a new function {@code (double d1, U u) -> int} that calls
     *      {@code f.call(d1, u, d3)} and returns the result.
     */
    static  net.mintern.functions.binary.DblObjToInt
    rbind(DblObjDblToInt f, double d3) {
        return (d1, u) -> f.call(d1, u, d3);
    }

    /**
     * Binds {@code (d3)} to the end of {@code this}, returning a new function
     * of type {@code (double, U) -> int}.
     *
     * @param d3 argument 3
     * @return a new function {@code (double d1, U u) -> int} that calls
     *      {@code this.call(d1, u, d3)} and returns the result.
     */
    @Override
    default net.mintern.functions.binary.DblObjToInt rbind(double d3) {
        return DblObjDblToInt.rbind(this, d3);
    }

    /**
     * Binds {@code (d1, u, d3)} to {@code f}, returning a new function
     * of type {@code () -> int}.
     *
     * @param  the type of the argument
     * @param f the unbound function
     * @param d1 argument 1
     * @param u argument 2
     * @param d3 argument 3
     * @return a new function {@code () -> int} that calls
     *      {@code f.call(d1, u, d3)} and returns the result.
     */
    static  net.mintern.functions.nullary.NilToInt
    bind(DblObjDblToInt f, double d1, U u, double d3) {
        return () -> f.call(d1, u, d3);
    }

    /**
     * Binds {@code (d1, u, d3)} to {@code this}, returning a new function
     * of type {@code () -> int}.
     *
     * @param d1 argument 1
     * @param u argument 2
     * @param d3 argument 3
     * @return a new function {@code () -> int} that calls
     *      {@code this.call(d1, u, d3)} and returns the result.
     */
    @Override
    default net.mintern.functions.nullary.NilToInt bind(double d1, U u, double d3) {
        return DblObjDblToInt.bind(this, d1, u, d3);
    }
}