numpy.testing.assert_allclose
- testing. assert_allclose ( actual, desired, rtol=1e-07, atol=0, equal_nan=True, err_msg='', verbose=True ) [source]
-
Raises an AssertionError if two objects are not equal up to desired tolerance.
The test is equivalent to
allclose(actual, desired, rtol, atol)
(note thatallclose
has different default values). It compares the difference betweenactual
anddesired
toatol + rtol * abs(desired)
.New in version 1.5.0.
- Parameters
-
- actual array_like
-
Array obtained.
- desired array_like
-
Array desired.
- rtol float, optional
-
Relative tolerance.
- atol float, optional
-
Absolute tolerance.
- equal_nan bool, optional.
-
If True, NaNs will compare equal.
- err_msg str, optional
-
The error message to be printed in case of failure.
- verbose bool, optional
-
If True, the conflicting values are appended to the error message.
- Raises
-
- AssertionError
-
If actual and desired are not equal up to specified precision.
Examples
>>> x = [1e-5, 1e-3, 1e-1] >>> y = np.arccos(np.cos(x)) >>> np.testing.assert_allclose(x, y, rtol=1e-5, atol=0)
© 2005–2021 NumPy Developers
Licensed under the 3-clause BSD License.
https://numpy.org/doc/1.22/reference/generated/numpy.testing.assert_allclose.html