mikera.matrixx.decompose.ILUResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vectorz Show documentation

Fast double-precision vector and matrix maths library for Java, supporting N-dimensional numeric arrays.

There is a newer version: 0.67.0

/*
 * Copyright (c) 2009-2014, 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 mikera.matrixx.decompose;

import mikera.matrixx.AMatrix;

/**
 * Interface for results of LU decomposition
 * 
 * 
 * LU Decomposition refactors the original matrix such that:

 * 
 *L*U = A where L is a lower triangular matrix, U is
 * an upper triangular matrix and A is the original matrix.
 * 
 * 
 * 

 * LU Decomposition is useful since once the decomposition has been performed
 * linear equations can be quickly solved and the original matrix A inverted.
 * Different algorithms can be selected to perform the decomposition, all will
 * have the same end result.
 * 
 *
 * @author Peter Abeles
 */
public interface ILUResult {

	/**
	 * 
	 * Returns the L matrix from the decomposition. This matrix will have ones
	 * on the leading diagonal.
	 * 
	 *
	 * @return The L matrix.
	 */
	public AMatrix getL();

	/**
	 * 
	 * Returns the U matrix from the decomposition.
	 * 
	 *
	 * @return The U matrix.
	 */
	public AMatrix getU();

	/**
	 * Computes the determinant from the LU decomposition.
	 * 
	 * @return The matrix's determinant.
	 */
	public double computeDeterminant();
}