org.ojalgo.function.ParameterFunction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ojalgo Show documentation
oj! Algorithms - ojAlgo - is Open Source Java code that has to do with mathematics, linear algebra and optimisation.
There is a newer version: 55.0.1
/*
 * Copyright 1997-2022 Optimatika
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package org.ojalgo.function;

import java.util.function.BiFunction;

import org.ojalgo.ProgrammingError;
import org.ojalgo.type.NumberDefinition;

public interface ParameterFunction> extends BasicFunction, BiFunction {

    /**
     * A {@linkplain ParameterFunction} with a set/fixed parameter.
     *
     * @author apete
     */
    public static final class FixedParameter> implements UnaryFunction {

        private final ParameterFunction myFunction;
        private final int myParameter;

        @SuppressWarnings("unused")
        private FixedParameter() {
            this(null, 0);
        }

        FixedParameter(final ParameterFunction function, final int param) {

            super();

            myFunction = function;
            myParameter = param;
        }

        public ParameterFunction getFunction() {
            return myFunction;
        }

        public int getParameter() {
            return myParameter;
        }

        public double invoke(final double arg) {
            return myFunction.invoke(arg, myParameter);
        }

        public float invoke(final float arg) {
            return myFunction.invoke(arg, myParameter);
        }

        public N invoke(final N arg) {
            return myFunction.invoke(arg, myParameter);
        }

    }

    default ParameterFunction andThen(final UnaryFunction after) {
        ProgrammingError.throwIfNull(after);
        return new ParameterFunction() {

            public double invoke(final double arg, final int param) {
                return after.invoke(ParameterFunction.this.invoke(arg, param));
            }

            public float invoke(final float arg, final int param) {
                return after.invoke(ParameterFunction.this.invoke(arg, param));
            }

            public N invoke(final N arg, final int param) {
                return after.invoke(ParameterFunction.this.invoke(arg, param));
            }

        };
    }

    default N apply(final N arg, final Integer param) {
        return this.invoke(arg, param.intValue());
    }

    default ParameterFunction compose(final UnaryFunction before) {
        ProgrammingError.throwIfNull(before);
        return new ParameterFunction() {

            public double invoke(final double arg, final int param) {
                return ParameterFunction.this.invoke(before.invoke(arg), param);
            }

            public float invoke(final float arg, final int param) {
                return ParameterFunction.this.invoke(before.invoke(arg), param);
            }

            public N invoke(final N arg, final int param) {
                return ParameterFunction.this.invoke(before.invoke(arg), param);
            }

        };
    }

    default byte invoke(final byte arg, final int param) {
        return (byte) this.invoke((double) arg, param);
    }

    double invoke(double arg, int param);

    default float invoke(final float arg, final int param) {
        return (float) this.invoke((double) arg, param);
    }

    default int invoke(final int arg, final int param) {
        return NumberDefinition.toInt(this.invoke((double) arg, param));
    }

    default long invoke(final long arg, final int param) {
        return NumberDefinition.toLong(this.invoke((double) arg, param));
    }

    N invoke(N arg, int param);

    default short invoke(final short arg, final int param) {
        return (short) this.invoke((double) arg, param);
    }

    /**
     * Turns this parameter function into a unary function with the parameter fixed/locked to the specified
     * value.
     *
     * @param param The parameter of the parameter function.
     * @return The resulting unary function.
     */
    default UnaryFunction parameter(final int param) {
        return new FixedParameter<>(this, param);
    }

}