binary.FloatFloatToFloat Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of functions-binary-extended Show documentation
Provides functional interfaces for most two-argument functions
There is a newer version: 2.0
Show newest version
package net.mintern.functions.binary;

/**
 * An operation of type {@code (float, float) -> float}.
 *
 */
@FunctionalInterface
public interface FloatFloatToFloat extends
        net.mintern.functions.binary.checked.FloatFloatToFloatE {

    /**
     * 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.FloatFloatToFloatE#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  FloatFloatToFloat unchecked(
            java.util.function.Function toRuntime,
            net.mintern.functions.binary.checked.FloatFloatToFloatE f) {
        return (fl1, fl2) -> {
            try {
                return f.call(fl1, fl2);
            } 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  FloatFloatToFloat unchecked(
            net.mintern.functions.binary.checked.FloatFloatToFloatE 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  FloatFloatToFloat uncheckedIO(
            net.mintern.functions.binary.checked.FloatFloatToFloatE f) {
        return unchecked(java.io.UncheckedIOException::new, f);
    }

    /**
     * Binds {@code (fl1)} to the beginning of {@code f}, returning a new function
     * of type {@code (float) -> float}.
     *
     * @param f the unbound function
     * @param fl1 argument 1
     * @return a new function {@code (float fl2) -> float} that calls
     *      {@code f.call(fl1, fl2)} and returns the result.
     */
    static  net.mintern.functions.unary.FloatToFloat
    bind(FloatFloatToFloat f, float fl1) {
        return (fl2) -> f.call(fl1, fl2);
    }

    /**
     * Binds {@code (fl1)} to the beginning of {@code this}, returning a new function
     * of type {@code (float) -> float}.
     *
     * @param fl1 argument 1
     * @return a new function {@code (float fl2) -> float} that calls
     *      {@code this.call(fl1, fl2)} and returns the result.
     */
    @Override
    default net.mintern.functions.unary.FloatToFloat bind(float fl1) {
        return FloatFloatToFloat.bind(this, fl1);
    }

    /**
     * Binds {@code (fl2)} to the end of {@code f}, returning a new function
     * of type {@code (float) -> float}.
     *
     * @param f the unbound function
     * @param fl2 argument 2
     * @return a new function {@code (float fl1) -> float} that calls
     *      {@code f.call(fl1, fl2)} and returns the result.
     */
    static  net.mintern.functions.unary.FloatToFloat
    rbind(FloatFloatToFloat f, float fl2) {
        return (fl1) -> f.call(fl1, fl2);
    }

    /**
     * Binds {@code (fl2)} to the end of {@code this}, returning a new function
     * of type {@code (float) -> float}.
     *
     * @param fl2 argument 2
     * @return a new function {@code (float fl1) -> float} that calls
     *      {@code this.call(fl1, fl2)} and returns the result.
     */
    @Override
    default net.mintern.functions.unary.FloatToFloat rbind(float fl2) {
        return FloatFloatToFloat.rbind(this, fl2);
    }

    /**
     * Binds {@code (fl1, fl2)} to {@code f}, returning a new function
     * of type {@code () -> float}.
     *
     * @param f the unbound function
     * @param fl1 argument 1
     * @param fl2 argument 2
     * @return a new function {@code () -> float} that calls
     *      {@code f.call(fl1, fl2)} and returns the result.
     */
    static  net.mintern.functions.nullary.NilToFloat
    bind(FloatFloatToFloat f, float fl1, float fl2) {
        return () -> f.call(fl1, fl2);
    }

    /**
     * Binds {@code (fl1, fl2)} to {@code this}, returning a new function
     * of type {@code () -> float}.
     *
     * @param fl1 argument 1
     * @param fl2 argument 2
     * @return a new function {@code () -> float} that calls
     *      {@code this.call(fl1, fl2)} and returns the result.
     */
    @Override
    default net.mintern.functions.nullary.NilToFloat bind(float fl1, float fl2) {
        return FloatFloatToFloat.bind(this, fl1, fl2);
    }
}