CholeskyDecomposition<T> Class

Represents the Cholesky decomposition of a positive-definite symmetric matrix.

Definition

Namespace: Numerics.NET.LinearAlgebra
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.4
C#
public abstract class CholeskyDecomposition<T> : Decomposition<T>
Inheritance
Object  →  LinearOperator<T>  →  Decomposition<T>  →  CholeskyDecomposition<T>

Type Parameters

T

Remarks

The Cholesky decomposition of a real symmetric positive definite matrix A rewrites the matrix in the form A= LLT, where L is a lower-triangular matrix.

CholeskyDecomposition<T> can operate in two modes. In overwrite mode, the original matrix is overwritten with the result of the decomposition. In preserve mode, the original matrix is preserved, and a new matrix is created to hold the decomposition. You can set the mode through the Overwrite property.

CholeskyDecomposition<T> inherits from LinearOperator<T>. This means you can use it to solve systems of linear equations where the matrix of the system is symmetric and positive definite. You can solve for a single right-hand side, or for multiple right-hand sides using the Solve(Vector<T>) method. You can also calculate the determinant the inverse, and an estimate for the condition number.

To solve a general (non-symmetric or non-positive definite)system of equations, use the LUDecomposition<T> class instead.

Constructors

CholeskyDecomposition<T> Constructs a new CholeskyDecomposition<T> object.

Properties

BaseMatrix Gets the underlying matrix of the decomposition.
(Inherited from Decomposition<T>)
ColumnCount Gets the number of columns in the matrix.
(Inherited from LinearOperator<T>)
ColumnIndex Gets or sets the index of labels for the columns of the matrix.
(Inherited from LinearOperator<T>)
Preliminary
Done Gets or sets a value that indicates whether the decomposition has been performed.
(Inherited from Decomposition<T>)
ElementType Gets the element type of the matrix.
(Inherited from LinearOperator<T>)
Factors Gets a collection of the matrix factors that make up the decomposition.
(Overrides Decomposition<T>.Factors)
LowerTriangularFactor Returns the lower triangular component of this CholeskyDecomposition<T>.
Overwrite Gets or sets whether the BaseMatrix should be overwritten by its decomposition.
(Inherited from Decomposition<T>)
Permutation Gets the permutation that is applied to both the rows and the columns of the base matrix before the decomposition.
RowCount Gets the number of rows in the matrix.
(Inherited from LinearOperator<T>)
RowIndex Gets or sets the index of labels for the rows of the matrix.
(Inherited from LinearOperator<T>)
Preliminary
UpperTriangularFactor Gets the upper triangular component of this CholeskyDecomposition<T>.

Methods

Decompose Performs the actual Cholesky decomposition.
(Overrides Decomposition<T>.Decompose())
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
EstimateConditionNumber Calculates an estimate for the condition number of the decomposed dense matrix.
(Overrides LinearOperator<T>.EstimateConditionNumber())
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetDeterminant Calculates the determinant of the factorized dense matrix.
(Overrides LinearOperator<T>.GetDeterminant())
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetInverse() Calculates the inverse matrix..
(Inherited from LinearOperator<T>)
GetInverse(Boolean) Calculates the inverse of the factorized symmetric matrix.
(Overrides LinearOperator<T>.GetInverse(Boolean))
GetObjectData Populates a SerializationInfo with the data needed to serialize the target object.
(Inherited from LinearOperator<T>)
Obsolete.
GetTypeGets the Type of the current instance.
(Inherited from Object)
IsSingular Gets whether the BaseMatrix of this decomposition is singular.
(Inherited from Decomposition<T>)
LeastSquaresSolve(Matrix<T>) Solves the system of linear equations for the specified right-hand side matrix in the least squares sense.
(Inherited from LinearOperator<T>)
LeastSquaresSolve(Vector<T>) Solves the system of linear equations for the specified right-hand side vector.
(Inherited from LinearOperator<T>)
LeastSquaresSolve(DenseMatrix<T>, Boolean) Solves the system of linear equations for the specified right-hand side dense matrix in the least squares sense and optionally overwrites the right-hand side with the solution.
(Inherited from LinearOperator<T>)
LeastSquaresSolve(DenseVector<T>, Boolean) Solves the system of linear equations for the specified right-hand side dense vector in the least squares sense and optionally overwrites the right-hand side with the solution.
(Inherited from LinearOperator<T>)
LeastSquaresSolveInto(Matrix<T>, Matrix<T>) Solves a system of equations defined by the matrix and multiple right-hand sides in the least squares sense.
(Inherited from LinearOperator<T>)
LeastSquaresSolveInto(Vector<T>, Vector<T>) Solves a system of equations defined by the matrix and the specified right-hand side in the least squares sense.
(Inherited from Decomposition<T>)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Multiply(Matrix<T>)Applies the linear operator to a matrix.
(Inherited from LinearOperator<T>)
Multiply(Vector<T>)Applies the linear operator to a vector.
(Inherited from LinearOperator<T>)
MultiplyAndAddAsLeftFactorCore Multiplies the matrix with a vector, adds the scaled result to another scaled vector, and returns the result.
(Inherited from Decomposition<T>)
MultiplyAsLeftCore(TransposeOperation, Matrix<T>, Matrix<T>) Multiplies a matrix by the linear operator and returns the result.
(Inherited from Decomposition<T>)
MultiplyAsLeftCore(TransposeOperation, Vector<T>, Vector<T>) Multiplies a vector by the linear operator and returns the result.
(Inherited from Decomposition<T>)
MultiplyTranspose(Matrix<T>)Applies the transpose of the linear operator to a matrix.
(Inherited from LinearOperator<T>)
MultiplyTranspose(Vector<T>)Applies the (conjugate) transpose of the linear operator to a vector.
(Inherited from LinearOperator<T>)
Rank() Returns the numerical rank of a matrix.
(Inherited from LinearOperator<T>)
Rank(T) Returns the numerical rank of the matrix using the specified tolerance.
(Overrides LinearOperator<T>.Rank(T))
SetSingular Sets a flag that indicates the underlying matrix of this decomposition is singular.
(Inherited from Decomposition<T>)
Solve(Matrix<T>) Solves the system of linear equations for the specified right-hand side matrix.
(Inherited from LinearOperator<T>)
Solve(Vector<T>) Solves the system of linear equations for the specified right-hand side vector.
(Inherited from LinearOperator<T>)
Solve(DenseMatrix<T>, Boolean) Solves the system of linear equations for the specified right-hand side dense matrix and optionally overwrites the right-hand side with the solution.
(Inherited from LinearOperator<T>)
Solve(DenseVector<T>, Boolean) Solves the system of linear equations for the specified right-hand side dense vector and optionally overwrites the right-hand side with the solution.
(Inherited from LinearOperator<T>)
SolveInto(Matrix<T>, Matrix<T>) Solves a system of equations defined by the matrix and multiple right-hand sides.
(Inherited from LinearOperator<T>)
SolveInto(Vector<T>, Vector<T>) Solves a system of equations defined by the matrix and the specified right-hand side.
(Inherited from LinearOperator<T>)
SolveInto(TransposeOperation, Matrix<T>, Matrix<T>) Solves a system of equations defined by the matrix and multiple right-hand sides.
(Overrides LinearOperator<T>.SolveInto(TransposeOperation, Matrix<T>, Matrix<T>))
SolveInto(TransposeOperation, Vector<T>, Vector<T>) Solves a system of equations defined by the matrix and the specified right-hand side.
(Overrides LinearOperator<T>.SolveInto(TransposeOperation, Vector<T>, Vector<T>))
SolveTranspose(Matrix<T>) Solves the transposed system of linear equations for the specified right-hand side matrix.
(Inherited from LinearOperator<T>)
SolveTranspose(Vector<T>) Solves the system of linear equations for the specified right-hand side vector.
(Inherited from LinearOperator<T>)
SolveTranspose(DenseMatrix<T>, Boolean) Solves the transposed system of linear equations for the specified right-hand side dense matrix and optionally overwrites the right-hand side with the solution.
(Inherited from LinearOperator<T>)
SolveTranspose(DenseVector<T>, Boolean) Solves the transposed system of linear equations for the specified right-hand side dense vector and optionally overwrites the right-hand side with the solution.
(Inherited from LinearOperator<T>)
SolveTransposeInto(Matrix<T>, Matrix<T>) Solves a system of equations defined by the matrix and multiple right-hand sides.
(Inherited from LinearOperator<T>)
SolveTransposeInto(Vector<T>, Vector<T>) Solves a system of equations defined by the matrix and the specified right-hand side.
(Inherited from LinearOperator<T>)
ToStringReturns a string that represents the current object.
(Inherited from Object)
TryDecompose Attempts to perform the actual Cholesky decomposition.

See Also