Skip to content

Commit

Permalink
docs: document Cholesky Decomposition (#192)
Browse files Browse the repository at this point in the history
  • Loading branch information
rotu authored Oct 14, 2024
1 parent 018b1ef commit f58cd6b
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion matrix.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1480,16 +1480,33 @@ export class EigenvalueDecomposition {
export { EigenvalueDecomposition as EVD };

/**
* The Cholesky decomposition of a matrix. Given a matrix A, the Cholesky Decomposition of A is L
* such that A = (L)(L.transpose).
* Only works for symmetric, positive definite matrix A.
*
* @link https://github.com/lutzroeder/Mapack/blob/master/Source/CholeskyDecomposition.cs
*/
export class CholeskyDecomposition {
/**
*
* @param value - The matrix to decompose
* @param value - The matrix A to decompose
* @throws if A is not symmetric
*/
constructor(value: MaybeMatrix);
/**
* true if A is positive definite (and therefore we could perform the decomposition)
*/
isPositiveDefinite(): boolean;
/**
* Given column vector b, solve for x such that Ax=b.
* @param value
* @throws if A is not positive-definite
*/
solve(value: Matrix): Matrix;
/**
* A lower triangular matrix L such that A=(L)(L.transpose)
* This will ONLY be the case if A is positive-definite.
*/
readonly lowerTriangularMatrix: Matrix;
}

Expand Down

0 comments on commit f58cd6b

Please sign in to comment.