org.ojalgo.function.multiary.PureQuadraticFunction 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.
The newest version!
/*
 * Copyright 1997-2025 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.multiary;

import org.ojalgo.matrix.store.MatrixStore;
import org.ojalgo.matrix.store.PhysicalStore;
import org.ojalgo.scalar.Scalar;
import org.ojalgo.structure.Access1D;
import org.ojalgo.structure.Access2D;

/**
 * [x]^T[Q][x] + c
 *
 * @author apete
 */
public final class PureQuadraticFunction> implements MultiaryFunction.TwiceDifferentiable, MultiaryFunction.PureQuadratic {

    public static final class Factory> {

        private Access2D myCoefficients = null;
        private final PhysicalStore.Factory myFactory;

        Factory(final PhysicalStore.Factory factory) {
            super();
            myFactory = factory;
        }

        public Factory coefficients(final Access2D coefficients) {
            myCoefficients = coefficients;
            return this;
        }

        public PureQuadraticFunction make(final int arity) {
            if (myCoefficients != null) {
                return new PureQuadraticFunction<>(myFactory.copy(myCoefficients));
            } else {
                return new PureQuadraticFunction<>(myFactory.make(arity, arity));
            }
        }

    }

    public static > Factory factory(final PhysicalStore.Factory factory) {
        return new Factory<>(factory);
    }

    public static > PureQuadraticFunction wrap(final PhysicalStore coefficients) {
        return new PureQuadraticFunction<>(coefficients);
    }

    private final MatrixStore myCoefficients;
    private final ConstantFunction myConstant;

    PureQuadraticFunction(final MatrixStore coefficients) {

        super();

        if (!coefficients.isSquare()) {
            throw new IllegalArgumentException("Must be sqaure!");
        }

        myCoefficients = coefficients;
        myConstant = new ConstantFunction<>(coefficients.countRows(), coefficients.physical());
    }

    @Override
    public int arity() {
        return (int) myCoefficients.countColumns();
    }

    @Override
    public N getConstant() {
        return myConstant.getConstant();
    }

    @Override
    public MatrixStore getGradient(final Access1D point) {

        final PhysicalStore retVal = myCoefficients.physical().make(this.arity(), 1L);

        this.getHessian(point).multiply(point, retVal);

        return retVal;
    }

    @Override
    public MatrixStore getHessian(final Access1D point) {
        return myCoefficients.add(myCoefficients.conjugate());
    }

    @Override
    public MatrixStore getLinearFactors(final boolean negated) {
        return myCoefficients.physical().makeZero(this.arity(), 1L);
    }

    @Override
    public N invoke(final Access1D arg) {
        return this.getScalarValue(arg).get();
    }

    @Override
    public PhysicalStore quadratic() {
        return (PhysicalStore) myCoefficients;
    }

    @Override
    public void setConstant(final Comparable constant) {
        myConstant.setConstant(constant);
    }

    PhysicalStore.Factory factory() {
        return myCoefficients.physical();
    }

    Scalar getScalarValue(final Access1D arg) {

        Scalar retVal = myConstant.getScalarConstant();

        return retVal.add(myCoefficients.multiplyBoth(arg));
    }

}