org.ejml.dense.row.linsol.LinearSolverAbstract_FDRM Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ejml-fdense Show documentation

A fast and easy to use dense and sparse matrix linear algebra library written in Java.

There is a newer version: 0.43.1

/*
 * Copyright (c) 2009-2020, Peter Abeles. All Rights Reserved.
 *
 * This file is part of Efficient Java Matrix Library (EJML).
 *
 * Licensed 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
 *
 *   http://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.ejml.dense.row.linsol;

import javax.annotation.Generated;
import org.ejml.data.FMatrixRMaj;
import org.ejml.interfaces.linsol.LinearSolverDense;
import org.jetbrains.annotations.Nullable;

/**
 * 
 * An abstract class that provides some common functionality and a default implementation
 * of invert that uses the solve function of the child class.
 * 
 *
 * 
 * The extending class must explicity call {@link #_setA(FMatrixRMaj)}
 * inside of its {@link #setA} function.
 * 
 *
 * @author Peter Abeles
 */
@Generated("org.ejml.dense.row.linsol.LinearSolverAbstract_DDRM")
public abstract class LinearSolverAbstract_FDRM implements LinearSolverDense {

    protected @Nullable FMatrixRMaj A;
    protected int numRows;
    protected int numCols;

    public @Nullable FMatrixRMaj getA() {
        return A;
    }

    protected void _setA( FMatrixRMaj A ) {
        this.A = A;
        this.numRows = A.numRows;
        this.numCols = A.numCols;
    }

    @Override
    public void invert( FMatrixRMaj A_inv ) {
        if (A == null)
            throw new RuntimeException("Must call setA() first");
        InvertUsingSolve_FDRM.invert(this, A, A_inv);
    }
}