Skip to content

Fix docstring of UMFPACKFactorization and KLUFactorization #649

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 28, 2025
Merged

Fix docstring of UMFPACKFactorization and KLUFactorization #649

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
00d31f6
Fix docstring of UMFPACKFactorization and KLUFactorization
mariekeosw Jul 28, 2025
c0247ea
Update src/factorization.jl
ChrisRackauckas Jul 28, 2025
d977ad4
Update src/factorization.jl
ChrisRackauckas Jul 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions src/factorization.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -861,9 +861,11 @@ patterns with “more structure”.
!!! note

By default, the SparseArrays.jl are implemented for efficiency by caching the
symbolic factorization. I.e., if `set_A` is used, it is expected that the new
`A` has the same sparsity pattern as the previous `A`. If this algorithm is to
be used in a context where that assumption does not hold, set `reuse_symbolic=false`.
symbolic factorization. If the sparsity pattern of `A` may change between solves, set `reuse_symbolic=false`.
If the pattern is assumed or known to be constant, set `reuse_symbolic=true` to avoid
unnecessary recomputation. To further reduce computational overhead, you can disable
pattern checks entirely by setting `check_pattern = false`. Note that this may error
if the sparsity pattern does change unexpectedly.
"""
Base.@kwdef struct UMFPACKFactorization <: AbstractSparseFactorization
reuse_symbolic::Bool = true
Expand All @@ -885,9 +887,11 @@ A fast sparse LU-factorization which specializes on sparsity patterns with “le
!!! note

By default, the SparseArrays.jl are implemented for efficiency by caching the
symbolic factorization. I.e., if `set_A` is used, it is expected that the new
`A` has the same sparsity pattern as the previous `A`. If this algorithm is to
be used in a context where that assumption does not hold, set `reuse_symbolic=false`.
symbolic factorization. If the sparsity pattern of `A` may change between solves, set `reuse_symbolic=false`.
If the pattern is assumed or known to be constant, set `reuse_symbolic=true` to avoid
unnecessary recomputation. To further reduce computational overhead, you can disable
pattern checks entirely by setting `check_pattern = false`. Note that this may error
if the sparsity pattern does change unexpectedly.
"""
Base.@kwdef struct KLUFactorization <: AbstractSparseFactorization
reuse_symbolic::Bool = true
Expand Down