Document Rayleigh-Ritz theory - #44
Merged
Merged
Conversation
ohno
marked this pull request as ready for review
August 11, 2026 15:15
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
1 participant
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.
Summary
LinearAlgebra.eigen(H, S)interface and add supporting referencesWhy
The existing page stated the generalized eigenvalue problem but did not show how it follows from the trial-wave-function expansion and constrained energy minimization. This gives readers the mathematical context needed to understand the solver before using it.
Impact
Users get a self-contained derivation directly before the usage examples. This is a documentation-only change and does not modify the package API or numerical behavior.
Validation
git diff --checkpassedjulia --startup-file=no --project=docs docs/make.jlcompleted on Julia 1.10.10 with doctests, executable examples, cross-references, and HTML renderingdocs/build/Rayleigh-Ritz.htmlcontains the Theory section and generalized eigenvalue derivationThis pull request was developed with assistance from Codex using GPT-5.6 Sol with High reasoning effort.