Skip to content

ENH: testing: support 0-D arrays for rtol and atol #743

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.

Sign up for GitHub

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

Merged
lucascolley merged 6 commits into from
May 17, 2026
+11 −5
Merged

ENH: testing: support 0-D arrays for rtol and atol #743

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4a65b5d
Adding case for non float rtol and atol inputs
prady0t May 16, 2026
941bd07
checking for ndim attribute instead
prady0t May 16, 2026
89dd532
changing condition
prady0t May 16, 2026
3848cf2
typing
lucascolley May 16, 2026
9e37931
try just `float`
lucascolley May 16, 2026
c7e31dd
Update src/array_api_extra/_lib/_testing.py
prady0t May 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions src/array_api_extra/_lib/_testing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,8 +228,8 @@ def xp_assert_close(
actual: Array,
desired: Array,
*,
rtol: float | None = None,
atol: float = 0,
rtol: float | Array | None = None,
atol: float | Array = 0,
equal_nan: bool = True,
err_msg: str = "",
verbose: bool = True,
Expand All @@ -246,9 +246,9 @@ def xp_assert_close(
The array produced by the tested function.
desired : Array
The expected array (typically hardcoded).
rtol : float, optional
rtol : float or Array, optional
Relative tolerance. Default: dtype-dependent.
atol : float, optional
atol : float or Array, optional
Comment thread
lucascolley marked this conversation as resolved.
Absolute tolerance. Default: 0.
equal_nan : bool, default: True
Whether to consider NaNs in corresponding locations as equal.
Expand All @@ -271,6 +271,8 @@ def xp_assert_close(
Notes
-----
The default `atol` and `rtol` differ from `xp.all(xpx.isclose(a, b))`.

Array arguments to `atol` and `rtol` must be valid input to :py:func:`float`.
"""
actual, desired, xp = _check_ns_shape_dtype(
actual, desired, check_dtype, check_shape, check_scalar
Expand All @@ -286,13 +288,17 @@ def xp_assert_close(
rtol = xp.finfo(actual.dtype).eps ** 0.5 * 4
else:
rtol = 1e-7
else:
rtol = float(rtol)

atol = float(atol)

actual_np = as_numpy_array(actual, xp=xp)
desired_np = as_numpy_array(desired, xp=xp)
np.testing.assert_allclose( # pyright: ignore[reportCallIssue]
actual_np,
desired_np,
rtol=rtol, # pyright: ignore[reportArgumentType]
rtol=rtol, # type: ignore[arg-type] # pyright: ignore[reportArgumentType]
atol=atol,
equal_nan=equal_nan,
err_msg=err_msg,
Expand Down