isoclose#

isoclose(actual, desired, rtol=1e-07, atol=0, is_plot=False, tol_label=None, xaxis=None)[source]#

Check if two arrays are equal up to desired tolerance.

The test is inspired from section 5.1 of ISO 532-1. It compares actual to desired +/- min(atol, rtol * abs(desired)).

Parameters:

actual (array_like) – Array obtained.
desired (array_like) – Array desired.
rtol (float, optional) – Relative tolerance. Default to 1e-7
atol (float, optional) – Absolute tolerance. Default to 0
is_plot (bool, optional) – To generate a “compliance” plot. Default to False
tol_label (str) – Label for the tolerance curves Default to None
xaxis (array_like, optional) – x axis for the “compliance” plot. Default to None

Returns:

is_isoclose – False if actual and desired are not equal up to specified tolerance.

Return type:

bool