Repository navigation
Improve the documentation - #90
Merged
Merged
Conversation
The manual now has five pages: - Introduction: the definition of a cover, the role of units, an example in which a cover exposes a well-conditioned matrix hidden by scaling (with the scale-invariant error bound for `A \ y`), cover-scaled regularization to make a symmetric matrix positive definite, and guidance on which function to use. - Cover objectives: penalty functions, the solver table, objective-minimal covers, and a new section defining transversals and showing why tightness on a maximum-product transversal matters for conditioning. - Solver invariants: covariance, uniqueness, and consuming one factor. - Starting points and convergence. - Reference. The roundoff worked example is replaced by the conditioning example. The `cover_transversal` docstring now defines a transversal. Assisted-by: Claude Opus 5.5 <noreply@anthropic.com>
Reorder explanations so that definitions and motivation precede details, replace ad hoc terms with plain statements, and split long list items. Correct the preconditioner that a zero `fillbudget` or `flopbudget` selects (the spanning-forest one, not a diagonal one), document the `strategies` keyword of `symcover_min` and `cover_min` with its defaults, state which entry `:leaveout` omits, and use zero tolerance in the `iscover` example, matching the guarantee stated for `cover`. Assisted-by: Claude Opus 5.5 <noreply@anthropic.com>
When the Cholesky preconditioner exceeds its fill or flop budget, LSQR falls back to spanning-forest preconditioning, not diagonal. Assisted-by: Claude Opus 5.5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #90 +/- ##
=======================================
Coverage 98.84% 98.84%
=======================================
Files 23 23
Lines 6303 6303
=======================================
Hits 6230 6230
Misses 73 73 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
This reorganizes the docs into separate pages, improves the exposition and examples, and polishes a bunch of docstrings.