Document the LDLT output representation - #336
Open
sylvesterkaczmarek wants to merge 1 commit into
Open
Conversation
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.
Summary
Doutput is an N x N diagonal matrix with zero off-diagonal elementsppas an N-element sequence of row and column swapsPptoppContext
Issue #119 identifies two separate concerns: the square representation of
Dand the lack of usable documentation for the permutation vector. ChangingDto a vector would alter the public API. This change preserves the current API and makes both existing output representations explicit, including the exact procedure for constructingP.This addresses the documentation portion of #119.
Validation
git diff --check-Wall -Wextra -Werror, using minimal test-only stubs for external CMSIS Core definitionsPfrompp, verifiedP A P^T = L D L^T, and checked that every off-diagonal element ofDis zeroDocumentation-only change. The full repository test suite was not run.