net.mintern.functions.ternary.checked.IntIntLongToIntE 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, long) -> int}.
 *
 * @param  the {@code Exception} type that the operation may throw
 */
@FunctionalInterface
public interface IntIntLongToIntE {

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

    /**
     * Binds {@code (i1)} to the beginning of {@code f}, returning a new function
     * of type {@code (int, long) -> 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, long l) -> int} that calls
     *      {@code f.call(i1, i2, l)} and returns the result.
     */
    static  net.mintern.functions.binary.checked.IntLongToIntE
    bind(IntIntLongToIntE f, int i1) {
        return (i2, l) -> f.call(i1, i2, l);
    }

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

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

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

    /**
     * Binds {@code (i1, i2)} to the beginning of {@code f}, returning a new function
     * of type {@code (long) -> 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 (long l) -> int} that calls
     *      {@code f.call(i1, i2, l)} and returns the result.
     */
    static  net.mintern.functions.unary.checked.LongToIntE
    bind(IntIntLongToIntE f, int i1, int i2) {
        return (l) -> f.call(i1, i2, l);
    }

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

    /**
     * Binds {@code (l)} 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 l argument 3
     * @return a new function {@code (int i1, int i2) -> int} that calls
     *      {@code f.call(i1, i2, l)} and returns the result.
     */
    static  net.mintern.functions.binary.checked.IntIntToIntE
    rbind(IntIntLongToIntE f, long l) {
        return (i1, i2) -> f.call(i1, i2, l);
    }

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

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

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