numpy 1.22.4 Pypi GitHub Homepage
Other Docs
ParametersRaisesBackRef
assert_allclose(actual, desired, rtol=1e-07, atol=0, equal_nan=True, err_msg='', verbose=True)

The test is equivalent to allclose(actual, desired, rtol, atol) (note that allclose has different default values). It compares the difference between :None:None:`actual` and :None:None:`desired` to atol + rtol * abs(desired) .

versionadded

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.

Raises an AssertionError if two objects are not equal up to desired tolerance.

See Also

assert_array_almost_equal_nulp
assert_array_max_ulp

Examples

This example is valid syntax, but we were not able to check execution
>>> x = [1e-5, 1e-3, 1e-1]
... y = np.arccos(np.cos(x))
... np.testing.assert_allclose(x, y, rtol=1e-5, atol=0)
See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

numpy.testing._private.utils.assert_approx_equal numpy.testing._private.utils.assert_array_almost_equal numpy.testing._private.utils.assert_almost_equal numpy.testing._private.utils.assert_array_equal

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


GitHub : /numpy/testing/_private/utils.py#1476
type: <class 'function'>
Commit: