cf.Domain.equivalent

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

True if and only if two domain are logically equivalent.

Equivalence is defined as both domain having the same data arrays after accounting for different but equivalent units, size one dimensions, dimension directions and dimension orders.

Parameters :
other :

The object to compare for equivalence.

atol : float, optional

The absolute tolerance for all numerical comparisons, By default the value returned by the ATOL function is used.

rtol : float, optional

The relative tolerance for all numerical comparisons, By default the value returned by the RTOL function is used.

traceback : bool, optional

If True then print a traceback highlighting where the two objects differ.

Returns :
out : bool

Whether or not the two objects are equivalent.

Previous topic

cf.Domain.equals

Next topic

cf.Domain.equivalent_transform

This Page