org.ojalgo.function.BinaryFunction Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ojalgo Show documentation
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.
/*
* Copyright 1997-2024 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.BinaryOperator;
import java.util.function.DoubleBinaryOperator;
import org.ojalgo.ProgrammingError;
import org.ojalgo.type.NumberDefinition;
public interface BinaryFunction> extends BasicFunction, BinaryOperator, DoubleBinaryOperator {
/**
* A {@linkplain BinaryFunction} with a set/fixed first argument.
*
* @author apete
*/
public static final class FixedFirst> implements UnaryFunction, NumberDefinition {
private final double myDoubleValue;
private final float myFloatValue;
private final BinaryFunction myFunction;
private final N myNumber;
FixedFirst(final double arg1, final BinaryFunction function) {
super();
myFunction = function;
myNumber = (N) Double.valueOf(arg1);
myDoubleValue = arg1;
myFloatValue = (float) arg1;
}
FixedFirst(final N arg1, final BinaryFunction function) {
super();
myFunction = function;
myNumber = arg1;
myDoubleValue = NumberDefinition.doubleValue(arg1);
myFloatValue = NumberDefinition.floatValue(arg1);
}
public double doubleValue() {
return myDoubleValue;
}
public float floatValue() {
return myFloatValue;
}
public BinaryFunction getFunction() {
return myFunction;
}
public N getNumber() {
return myNumber;
}
public double invoke(final double arg2) {
return myFunction.invoke(myDoubleValue, arg2);
}
public float invoke(final float arg2) {
return myFunction.invoke(myFloatValue, arg2);
}
public N invoke(final N arg2) {
return myFunction.invoke(myNumber, arg2);
}
}
/**
* A {@linkplain BinaryFunction} with a set/fixed second argument.
*
* @author apete
*/
public static final class FixedSecond> implements UnaryFunction, NumberDefinition {
private final double myDoubleValue;
private final float myFloatValue;
private final BinaryFunction myFunction;
private final N myNumber;
FixedSecond(final BinaryFunction function, final double arg2) {
super();
myFunction = function;
myNumber = (N) Double.valueOf(arg2);
myDoubleValue = arg2;
myFloatValue = (float) arg2;
}
FixedSecond(final BinaryFunction function, final N arg2) {
super();
myFunction = function;
myNumber = arg2;
myDoubleValue = NumberDefinition.doubleValue(arg2);
myFloatValue = NumberDefinition.floatValue(arg2);
}
public double doubleValue() {
return myDoubleValue;
}
public float floatValue() {
return myFloatValue;
}
public BinaryFunction getFunction() {
return myFunction;
}
public N getNumber() {
return myNumber;
}
public double invoke(final double arg1) {
return myFunction.invoke(arg1, myDoubleValue);
}
public float invoke(final float arg1) {
return myFunction.invoke(arg1, myFloatValue);
}
public N invoke(final N arg1) {
return myFunction.invoke(arg1, myNumber);
}
}
default BinaryFunction andThen(final UnaryFunction after) {
ProgrammingError.throwIfNull(after);
return new BinaryFunction<>() {
public double invoke(final double arg1, final double arg2) {
return after.invoke(BinaryFunction.this.invoke(arg1, arg2));
}
public float invoke(final float arg1, final float arg2) {
return after.invoke(BinaryFunction.this.invoke(arg1, arg2));
}
public N invoke(final N arg1, final double arg2) {
return after.invoke(BinaryFunction.this.invoke(arg1, arg2));
}
public N invoke(final N arg1, final N arg2) {
return after.invoke(BinaryFunction.this.invoke(arg1, arg2));
}
};
}
/**
* @see java.util.function.BiFunction#apply(java.lang.Object, java.lang.Object)
*/
default N apply(final N arg1, final N arg2) {
return this.invoke(arg1, arg2);
}
/**
* @see java.util.function.DoubleBinaryOperator#applyAsDouble(double, double)
*/
default double applyAsDouble(final double arg1, final double arg2) {
return this.invoke(arg1, arg2);
}
/**
* To allow syntax like array.modifyAll(DIVIDE.by(3.0));
*
* @see #second(double)
*/
default UnaryFunction by(final double arg2) {
return this.second(arg2);
}
/**
* To allow syntax like array.modifyAll(DIVIDE.by(3.0));
*
* @see #second(double)
*/
default UnaryFunction by(final N arg2) {
return this.second(arg2);
}
/**
* @see #first(Comparable)
*/
default UnaryFunction first(final double arg1) {
return new FixedFirst<>(arg1, this);
}
/**
* Turns this binary function into a unary function with the first argument fixed/locked to the specified
* value.
*
* @param arg1 The first argument of the binary function.
* @return The resulting unary function.
*/
default UnaryFunction first(final N arg1) {
return new FixedFirst<>(arg1, this);
}
default byte invoke(final byte arg1, final byte arg2) {
return (byte) this.invoke((double) arg1, (double) arg2);
}
double invoke(double arg1, double arg2);
default float invoke(final float arg1, final float arg2) {
return (float) this.invoke((double) arg1, (double) arg2);
}
default int invoke(final int arg1, final int arg2) {
return NumberDefinition.toInt(this.invoke((double) arg1, (double) arg2));
}
default long invoke(final long arg1, final long arg2) {
return NumberDefinition.toLong(this.invoke((double) arg1, (double) arg2));
}
N invoke(N arg1, double arg2);
N invoke(N arg1, N arg2);
default short invoke(final short arg1, final short arg2) {
return (short) this.invoke((double) arg1, (double) arg2);
}
/**
* @see #second(Comparable)
*/
default UnaryFunction second(final double arg2) {
return new FixedSecond<>(this, arg2);
}
/**
* Turns this binary function into a unary function with the second argument fixed/locked to the specified
* value.
*
* @param arg2 The second argument of the binary function.
* @return The resulting unary function.
*/
default UnaryFunction second(final N arg2) {
return new FixedSecond<>(this, arg2);
}
}