Skip to content

Commit 00d31f6

Browse files
mariekeoswMarieke Osewold
authored andcommitted
Fix docstring of UMFPACKFactorization and KLUFactorization
1 parent 0427d49 commit 00d31f6

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

src/factorization.jl

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -861,9 +861,13 @@ patterns with “more structure”.
861861
!!! note
862862
863863
By default, the SparseArrays.jl are implemented for efficiency by caching the
864-
symbolic factorization. I.e., if `set_A` is used, it is expected that the new
865-
`A` has the same sparsity pattern as the previous `A`. If this algorithm is to
866-
be used in a context where that assumption does not hold, set `reuse_symbolic=false`.
864+
symbolic factorization.
865+
866+
If the sparsity pattern of `A` may change between solves, set `reuse_symbolic=false`.
867+
If the pattern is assumed or known to be constant, set `reuse_symbolic=true` to avoid
868+
unnecessary recomputation. To further reduce computational overhead, you can disable
869+
pattern checks entirely by setting `check_pattern = false`. Note that this may error
870+
if the sparsity pattern does change unexpectedly.
867871
"""
868872
Base.@kwdef struct UMFPACKFactorization <: AbstractSparseFactorization
869873
reuse_symbolic::Bool = true
@@ -885,9 +889,13 @@ A fast sparse LU-factorization which specializes on sparsity patterns with “le
885889
!!! note
886890
887891
By default, the SparseArrays.jl are implemented for efficiency by caching the
888-
symbolic factorization. I.e., if `set_A` is used, it is expected that the new
889-
`A` has the same sparsity pattern as the previous `A`. If this algorithm is to
890-
be used in a context where that assumption does not hold, set `reuse_symbolic=false`.
892+
symbolic factorization.
893+
894+
If the sparsity pattern of `A` may change between solves, set `reuse_symbolic=false`.
895+
If the pattern is assumed or known to be constant, set `reuse_symbolic=true` to avoid
896+
unnecessary recomputation. To further reduce computational overhead, you can disable
897+
pattern checks entirely by setting `check_pattern = false`. Note that this may error
898+
if the sparsity pattern does change unexpectedly.
891899
"""
892900
Base.@kwdef struct KLUFactorization <: AbstractSparseFactorization
893901
reuse_symbolic::Bool = true

0 commit comments

Comments
 (0)