Skip to content

Commit 10168b1

Browse files
Merge pull request #649 from mariekeosw/mariekeosw-patch-1
Fix docstring of UMFPACKFactorization and KLUFactorization
2 parents 0427d49 + d977ad4 commit 10168b1

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

src/factorization.jl

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -861,9 +861,11 @@ 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. If the sparsity pattern of `A` may change between solves, set `reuse_symbolic=false`.
865+
If the pattern is assumed or known to be constant, set `reuse_symbolic=true` to avoid
866+
unnecessary recomputation. To further reduce computational overhead, you can disable
867+
pattern checks entirely by setting `check_pattern = false`. Note that this may error
868+
if the sparsity pattern does change unexpectedly.
867869
"""
868870
Base.@kwdef struct UMFPACKFactorization <: AbstractSparseFactorization
869871
reuse_symbolic::Bool = true
@@ -885,9 +887,11 @@ A fast sparse LU-factorization which specializes on sparsity patterns with “le
885887
!!! note
886888
887889
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`.
890+
symbolic factorization. If the sparsity pattern of `A` may change between solves, set `reuse_symbolic=false`.
891+
If the pattern is assumed or known to be constant, set `reuse_symbolic=true` to avoid
892+
unnecessary recomputation. To further reduce computational overhead, you can disable
893+
pattern checks entirely by setting `check_pattern = false`. Note that this may error
894+
if the sparsity pattern does change unexpectedly.
891895
"""
892896
Base.@kwdef struct KLUFactorization <: AbstractSparseFactorization
893897
reuse_symbolic::Bool = true

0 commit comments

Comments
 (0)