org.ejml.interfaces.linsol.LinearSolverDense Maven / Gradle / Ivy

/*
 * Copyright (c) 2009-2017, 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.interfaces.linsol;

import org.ejml.LinearSolverSafe;
import org.ejml.data.Matrix;


/**
 * 
 * An implementation of LinearSolverDense solves a linear system or inverts a matrix.  It masks more complex
 * implementation details, while giving the programmer control over memory management and performance.
 * To quickly detect nearly singular matrices without computing the SVD the {@link #quality()}
 * function is provided.
 * 
 *
 * 
 * A linear system is defined as:
 * A*X = B.

 * where A ∈ ℜ ^{m × n}, X ∈ ℜ ^{n × p},
 * B ∈ ℜ ^{m × p}.  Different implementations can solve different
 * types and shapes in input matrices and have different memory and runtime performance.
 *
 *
 * To solve a system:

 * 
 *  Call {@link #setA(org.ejml.data.Matrix)}
 * 
 Call {@link #solve(org.ejml.data.Matrix, org.ejml.data.Matrix)}.
 * 
 *
 * To invert a matrix:
 * 
 *  Call {@link #setA(org.ejml.data.Matrix)}
 * 
 Call {@link #invert(org.ejml.data.Matrix)}.
 * 
 * 
 * A matrix can also be inverted by passing in an identity matrix to solve, but this will be
 * slower and more memory intensive than the specialized invert() function.
 * 
 *
 * 
 * IMPORTANT: Depending upon the implementation, input matrices might be overwritten by
 * the solver.  This
 * reduces memory and computational requirements and give more control to the programmer.  If
 * the input matrices need to be not modified then {@link LinearSolverSafe} can be used.  The
 * functions {@link #modifiesA()} and {@link #modifiesB()} specify which input matrices are being
 * modified.
 * 
 *
 * @author Peter Abeles
 */
public interface LinearSolverDense< T extends Matrix> extends LinearSolver {

    /**
     * Computes the inverse of of the 'A' matrix passed into {@link #setA(Matrix)}
     * and writes the results to the provided matrix.  If 'A_inv' needs to be different from 'A'
     * is implementation dependent.
     *
     * @param A_inv Where the inverted matrix saved. Modified.
     */
    void invert(T A_inv);

}