LinearEqualityConstraint.java

/*
 * Licensed to the Hipparchus project under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The Hipparchus project licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.hipparchus.optim.nonlinear.vector.constrained;


import org.hipparchus.linear.Array2DRowRealMatrix;
import org.hipparchus.linear.ArrayRealVector;
import org.hipparchus.linear.RealMatrix;
import org.hipparchus.linear.RealVector;
import org.hipparchus.optim.OptimizationData;
/** A set of linear equality constraints given as Ax = b.
 * @since 3.1
 */
public class LinearEqualityConstraint extends EqualityConstraint implements OptimizationData {

    /** Matrix of linear weights. */
    private final RealMatrix a;

    /**
     * Construct a set of linear equality constraints ax = b. Represents
     * equations a[i].x = b[i], for each row of a.
     *
     * @param a the matrix of linear weights
     * @param b the vector of constants
     */
    public LinearEqualityConstraint(final RealMatrix a, final RealVector b) {
        super(b);
        this.a = a;
    }

    /**
     * Construct a set of linear equality constraints ax = b. Represents
     * equations a[i].x = b[i], for each row of a.
     *
     * @param a the matrix of linear weights
     * @param b the vector of constants
     */
    public LinearEqualityConstraint(final double[][] a, final double[] b) {
        this(new Array2DRowRealMatrix(a), new ArrayRealVector(b));
    }

    /** Get the matrix of linear weights.
     * @return matrix of linear weights
     */
    public RealMatrix getA() {
        return a;
    }

    @Override
    public int dim() {
        return a.getColumnDimension();
    }

    @Override
    public RealVector value(final RealVector x) {
        return a.operate(x);
    }

    @Override
    public RealMatrix jacobian(final RealVector x) {
        return a.copy();
    }

}