net.mintern.functions.ternary.checked.DblDblIntToIntE 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.checked;

/**
 * An operation of type {@code (double, double, int) -> int}.
 *
 * @param  the {@code Exception} type that the operation may throw
 */
@FunctionalInterface
public interface DblDblIntToIntE {

    /**
     * Performs this operation.
     *
     * @param d1 argument 1
     * @param d2 argument 2
     * @param i argument 3
     * @return the result of the operation
     * @throws E if the operation cannot be completed
     */
    int call(double d1, double d2, int i) throws E;

    /**
     * Binds {@code (d1)} to the beginning of {@code f}, returning a new function
     * of type {@code (double, int) -> int}.
     *
     * @param  the {@code Exception} type that the operation may throw
     * @param f the unbound function
     * @param d1 argument 1
     * @return a new function {@code (double d2, int i) -> int} that calls
     *      {@code f.call(d1, d2, i)} and returns the result.
     */
    static  net.mintern.functions.binary.checked.DblIntToIntE
    bind(DblDblIntToIntE f, double d1) {
        return (d2, i) -> f.call(d1, d2, i);
    }

    /**
     * Binds {@code (d1)} to the beginning of {@code this}, returning a new function
     * of type {@code (double, int) -> int}.
     *
     * @param d1 argument 1
     * @return a new function {@code (double d2, int i) -> int} that calls
     *      {@code this.call(d1, d2, i)} and returns the result.
     */
    default net.mintern.functions.binary.checked.DblIntToIntE bind(double d1) {
        return DblDblIntToIntE.bind(this, d1);
    }

    /**
     * Binds {@code (d2, i)} to the end of {@code f}, returning a new function
     * of type {@code (double) -> int}.
     *
     * @param  the {@code Exception} type that the operation may throw
     * @param f the unbound function
     * @param d2 argument 2
     * @param i argument 3
     * @return a new function {@code (double d1) -> int} that calls
     *      {@code f.call(d1, d2, i)} and returns the result.
     */
    static  net.mintern.functions.unary.checked.DblToIntE
    rbind(DblDblIntToIntE f, double d2, int i) {
        return (d1) -> f.call(d1, d2, i);
    }

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

    /**
     * Binds {@code (d1, d2)} to the beginning of {@code f}, returning a new function
     * of type {@code (int) -> int}.
     *
     * @param  the {@code Exception} type that the operation may throw
     * @param f the unbound function
     * @param d1 argument 1
     * @param d2 argument 2
     * @return a new function {@code (int i) -> int} that calls
     *      {@code f.call(d1, d2, i)} and returns the result.
     */
    static  net.mintern.functions.unary.checked.IntToIntE
    bind(DblDblIntToIntE f, double d1, double d2) {
        return (i) -> f.call(d1, d2, i);
    }

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

    /**
     * Binds {@code (i)} to the end of {@code f}, returning a new function
     * of type {@code (double, double) -> int}.
     *
     * @param  the {@code Exception} type that the operation may throw
     * @param f the unbound function
     * @param i argument 3
     * @return a new function {@code (double d1, double d2) -> int} that calls
     *      {@code f.call(d1, d2, i)} and returns the result.
     */
    static  net.mintern.functions.binary.checked.DblDblToIntE
    rbind(DblDblIntToIntE f, int i) {
        return (d1, d2) -> f.call(d1, d2, i);
    }

    /**
     * Binds {@code (i)} to the end of {@code this}, returning a new function
     * of type {@code (double, double) -> int}.
     *
     * @param i argument 3
     * @return a new function {@code (double d1, double d2) -> int} that calls
     *      {@code this.call(d1, d2, i)} and returns the result.
     */
    default net.mintern.functions.binary.checked.DblDblToIntE rbind(int i) {
        return DblDblIntToIntE.rbind(this, i);
    }

    /**
     * Binds {@code (d1, d2, i)} to {@code f}, returning a new function
     * of type {@code () -> int}.
     *
     * @param  the {@code Exception} type that the operation may throw
     * @param f the unbound function
     * @param d1 argument 1
     * @param d2 argument 2
     * @param i argument 3
     * @return a new function {@code () -> int} that calls
     *      {@code f.call(d1, d2, i)} and returns the result.
     */
    static  net.mintern.functions.nullary.checked.NilToIntE
    bind(DblDblIntToIntE f, double d1, double d2, int i) {
        return () -> f.call(d1, d2, i);
    }

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