Skip to content

ENH: array comparison utils show calculations and indices of max errors #29395

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

danra
Copy link
Contributor

@danra danra commented Jul 19, 2025

Resolves #28827

  • Verbose assertion errors raised by testing.assert_allclose and testing.assert_array_XXX now show the calculation and the indices of the maximum absolute and relative differences among the violations.
  • Assertion errors raised by assert_array_almost_equal_nulp and assert_array_max_ulp, which have no verbose toggle, now show the indices of the maximum ULP difference.

The main complexity adding this feature was that one could not 'simply' replace max with argmax due to masking: the absolute differences is calculated after masking out infs and nans, and the relative differences are additionally calculated after masking out zero denominators.


Notes to reviewer:

  1. Based over MNT: Cleanup infs handling in np.testing assertion utilities #29321 which should be merged first.
  2. Best reviewed going over commits one-by-one. Main change is in the last commit, preceding commits lead up to it with minor preparations.

danra added 13 commits July 18, 2025 16:30
Recently, numpy#29112 added showing first mismatches indices, but
assert_array_almost_equal.compare trips it up by returning a shape
different from its input, causing an IndexError:

```
    <...>
    if invalids.ndim != 0:
        if flagged.ndim > 0:
>           positions = np.argwhere(np.asarray(~flagged))[invalids]
E           IndexError: boolean index did not match indexed array along axis 0; size of axis is 3 but size of corresponding boolean axis is 2
```
(traceback shown using pytest --full-trace)
A nice cleanup (newer, similar inf handling already exists now in
assert_array_compare), and resolves the shape mismatch issue. However,
the removed logic was handling complex infs while the one isn't, causing
the new test and an existing one (TestInterp::test_complex_interp) to
now fail with RuntimeWarnings attempting to subtract the complex infs.
assert_array_compare now tests all inf values for matching position
and value, including complex infs.

Fixes the failing tests.
The behavior for real infs is the same is before.

For complex infs, demonstrates that the behavior for mismatching
values is now cleaner, showing a concise error message vs.
previously displaying nan max errors.

For complex infs with matching values, the behavior is the same as
before, accepting them as equal (although internally they would
now be filtered ahead of being passed to isclose, like real infs
already had been).
Noticed the extra dimension while adding the index of the max error to
assert_array_XXX_nulp output
Noticed these while attempting to append more content to the
expected message, upon which the partial values started
causing the regex to stop matching.
Resolves numpy#28827

- Verbose assertion errors raised by testing.assert_allclose and
  testing.assert_array_XXX now show the calculation and the indices of
  the maximum absolute and relative differences among the violations.
- Assertion errors raised by assert_array_almost_equal_nulp and
  assert_array_max_ulp, which have no verbose toggle, now show the
  indices of the maximum ULP difference.

The main complexity adding this feature was that one could not 'simply'
replace `max` with `argmax` due to masking: the absolute differences is
calculated after masking out infs and nans, and the relative differences
are additionally calculated after masking out zero denominators.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ENH: assert_allclose show indices and values of maximum differences on failure
1 participant