Add a "Solving linear systems" section to the sparse solvers manual - #841
Merged
Merged
Conversation
Describe what `A \ b` and `factorize` dispatch to for a sparse matrix, how to reuse and refactorize a factorization, how to extract the factors and the identities they satisfy, and the symmetric-input and `check = false` rules, with doctested examples. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #841 +/- ##
==========================================
+ Coverage 92.60% 92.64% +0.04%
==========================================
Files 12 12
Lines 8727 8721 -6
==========================================
- Hits 8082 8080 -2
+ Misses 645 641 -4 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Removed redundant information about factorization precision and types in the sparse QR section.
Removed notes on `lu` factorization and output array requirements for other factorizations.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The solvers page listed the factorizations and their docstrings but had no narrative. This adds a section covering what
A \ bandfactorizedispatch to (substitution,choleskywith its fallback,lu,qr, andlqfor the minimum-norm solution of wide systems), reusing and refactorizing a factorization (F \ B,ldiv!,lu!/cholesky!/ldlt!), extracting factors with the permuted identities they satisfy, and the symmetric-input andcheck = false/issuccessrules.The material comes from reading
\andfactorizeinsrc/linalg.jl, the Hermitian\insrc/solvers/cholmod.jl, thelu/cholesky/qr/lqdocstrings, and #830, #831, #833, #835. One thing the text makes explicit: for a Hermitian matrix that is not positive definite,\falls back toluwhilefactorizefalls back toldlt. Every example is a doctest printing onlytrue/false; the Documenter build and doctests pass on nightly with no new warnings. Docs only; tuning keywords and threading are left to a separate PR.The insertion sits directly above the
@docsline that #838 edits, so whichever merges second will need a trivial rebase.🤖 Generated with Claude Code