docs: clarify usolve's upper-triangular input requirement - #3703
Open
Hugohong258 wants to merge 1 commit into
Open
Hugohong258 wants to merge 1 commit into
Hugohong258 wants to merge 1 commit into
Conversation
This branch has not been deployed
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.
usolveassumes its input is upper triangular but does not validate that condition. Passing a non-upper-triangular matrix can return an incorrect result or produce a misleading singular-matrix error. Clarify this limitation in the function JSDoc and embedded help text.Addresses the documentation part of #2333.
Validation: reproduced the issue against
src/defaultInstance.jswith a non-singular matrix (determinant ≈ -119.34) that triggers the singular-matrix error;npx mocha test/unit-tests/function/algebra/solver/usolve.test.js(7 passing); targeted ESLint andgit diff --checkpassed. This is documentation only; solver behavior is unchanged.