net.mintern.functions.ternary.checked.IntIntIntToIntE 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
There is a newer version: 2.0
Show newest version
package net.mintern.functions.ternary.checked;

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

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

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

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

    /**
     * Binds {@code (i2, i3)} to the end 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 i2 argument 2
     * @param i3 argument 3
     * @return a new function {@code (int i1) -> int} that calls
     *      {@code f.call(i1, i2, i3)} and returns the result.
     */
    static  net.mintern.functions.unary.checked.IntToIntE
    rbind(IntIntIntToIntE f, int i2, int i3) {
        return (i1) -> f.call(i1, i2, i3);
    }

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

    /**
     * Binds {@code (i1, i2)} 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 i1 argument 1
     * @param i2 argument 2
     * @return a new function {@code (int i3) -> int} that calls
     *      {@code f.call(i1, i2, i3)} and returns the result.
     */
    static  net.mintern.functions.unary.checked.IntToIntE
    bind(IntIntIntToIntE f, int i1, int i2) {
        return (i3) -> f.call(i1, i2, i3);
    }

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

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

    /**
     * Binds {@code (i3)} to the end of {@code this}, returning a new function
     * of type {@code (int, int) -> int}.
     *
     * @param i3 argument 3
     * @return a new function {@code (int i1, int i2) -> int} that calls
     *      {@code this.call(i1, i2, i3)} and returns the result.
     */
    default net.mintern.functions.binary.checked.IntIntToIntE rbind(int i3) {
        return IntIntIntToIntE.rbind(this, i3);
    }

    /**
     * Binds {@code (i1, i2, i3)} 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 i1 argument 1
     * @param i2 argument 2
     * @param i3 argument 3
     * @return a new function {@code () -> int} that calls
     *      {@code f.call(i1, i2, i3)} and returns the result.
     */
    static  net.mintern.functions.nullary.checked.NilToIntE
    bind(IntIntIntToIntE f, int i1, int i2, int i3) {
        return () -> f.call(i1, i2, i3);
    }

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