cf.FieldAncillary.equivalent

FieldAncillary.equivalent(other, rtol=None, atol=None, traceback=False)[source]

True if two constructs are equal, False otherwise.

Two real numbers x and y are considered equal if |x-y|<=atol+rtol|y|, where atol (the tolerance on absolute differences) and rtol (the tolerance on relative differences) are positive, typically very small numbers. See the atol and rtol parameters.

Parameters
other:

The object to compare for equality.

atol: float, optional

The tolerance on absolute differences between real numbers. The default value is set by the atol function.

rtol: float, optional

The tolerance on relative differences between real numbers. The default value is set by the rtol function.