papyri
This is a pre-release version (2.5.0.dev0+git20251130.2de293a). Go to latest (2.4.4)
{ } Raw JSON

bundles / numpy 2.5.0.dev0+git20251130.2de293a / numpy / testing / _private / utils / assert_approx_equal

function

numpy.testing._private.utils:assert_approx_equal

source: build-install/usr/lib/python3.14/site-packages/numpy/testing/_private/utils.py :634

Signature

def   assert_approx_equal ( actual ,  desired ,  significant = 7 ,  err_msg = '' ,  verbose = True )

Summary

Raises an AssertionError if two items are not equal up to significant digits.

Extended Summary

Given two numbers, check that they are approximately equal. Approximately equal is defined as the number of significant digits that agree.

Parameters

actual : scalar

The object to check.

desired : scalar

The expected object.

significant : int, optional

Desired precision, default is 7.

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

np.testing.assert_approx_equal(0.12345677777777e-20, 0.1234567e-20)
np.testing.assert_approx_equal(0.12345670e-20, 0.12345671e-20,
                               significant=8)
np.testing.assert_approx_equal(0.12345670e-20, 0.12345672e-20,
                               significant=8)
the evaluated condition that raises the exception is 
abs(0.12345670e-20/1e-21 - 0.12345672e-20/1e-21) >= 10**-(8-1)

See also

assert_allclose

Compare two array_like objects for equality with desired relative and/or absolute precision.

assert_array_almost_equal_nulp
assert_array_max_ulp
assert_equal

Aliases

  • numpy.testing.assert_approx_equal