Skip to content

Commit 8a7bdfe

Browse files
committed
Add CHOLMOD docs about materializing; list all components
1 parent bcbb1cc commit 8a7bdfe

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

src/solvers/cholmod.jl

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1567,6 +1567,12 @@ using just `L` without accounting for `P` will give incorrect answers.
15671567
To include the effects of permutation,
15681568
it's typically preferable to extract "combined" factors like `PtL = F.PtL`
15691569
(the equivalent of `P'*L`) and `LtP = F.UP` (the equivalent of `L'*P`).
1570+
The complete list of supported factors is `:L, :PtL, :UP, :U`.
1571+
The permutation vector is available as `F.p`, defined such that `L*L' == A[p, p]`,
1572+
1573+
The `L` component can be materialized as a sparse matrix using `sparse(F.L)`.
1574+
Other components cannot be materialized directly, but can be reconstructed
1575+
from `sparse(F.L)` and `F.p` if needed.
15701576
15711577
When `check = true`, an error is thrown if the decomposition fails.
15721578
When `check = false`, responsibility for checking the decomposition's
@@ -1744,6 +1750,11 @@ To include the effects of permutation, it is typically preferable to extract
17441750
"combined" factors like `PtL = F.PtL` (the equivalent of
17451751
`P'*L`) and `LtP = F.UP` (the equivalent of `L'*P`).
17461752
The complete list of supported factors is `:L, :PtL, :D, :UP, :U, :LD, :DU, :PtLD, :DUP`.
1753+
The permutation vector is available as `F.p`, defined such that `L*D*L' == A[p, p]`,
1754+
1755+
The `LD` component can be materialized as a sparse matrix using `sparse(F.LD)`,
1756+
Other components cannot be materialized directly, but can be reconstructed from
1757+
`sparse(F.LD)` and `F.p` if needed.
17471758
17481759
Unlike the related Cholesky factorization, the ``LDL'`` factorization does not
17491760
require `A` to be positive definite. However, it still requires all leading

0 commit comments

Comments
 (0)