Fix #764: wrong SymbolicOperator.isclose() result #1114
+113
−14
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
Changes: 1. `isclose()` now accepts relative and absolute tolerances. This allows for more precise control over the comparison, just like in NumPy. 2. The comparison logic was corrected. The old implementation used a single tolerance value that it scaled in a way that could produce incorrect results. The new logic uses a common formula for checking if 1 numbers are close: ``` abs(a - b) <= abs_tol + rel_tol * max(abs(a), abs(b)) ``` 3. Updated `__eq__` in `SymbolicOperator` to use the tolerance values. 4. Added a new test `symbolic_operator_test.py`.
mpharrigan
reviewed
Aug 25, 2025
Comment on lines
630
to
631
| rel_tol(float): Relative tolerance. | ||
| abs_tol(float): Absolute tolerance. |
There was a problem hiding this comment.
consider rtol and atol for consistency with numpy/scipy
| @@ -618,15 +618,17 @@ def __next__(self): | |||
| term, coefficient = next(self._iter) | |||
| return self.__class__(term=term, coefficient=coefficient) | |||
|
|
|||
| def isclose(self, other, tol=EQ_TOLERANCE): | |||
| def isclose(self, other, rel_tol=EQ_TOLERANCE, abs_tol=EQ_TOLERANCE): | |||
There was a problem hiding this comment.
this is technically a breaking API change. are we ok with that? weigh confusion vs. code compatibility to keeping one of them named tol
There was a problem hiding this comment.
Yeah, maybe we could keep 'tol' as a deprecated parameter and set atol=tol if it exists.
|
gentle ping |
Per comments in PR review, this renames `rel_tol` and `abs_tol` to be `rtol` and `atol`, respectively, as well ask keeps the previous `tol` parameter but marks it as deprecated.
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.
Changes:
isclose()now accepts relative and absolute tolerances. This allows for more precise control over the comparison, just like in NumPy.__eq__inSymbolicOperatorto use the tolerance values.symbolic_operator_test.py.