cf.TimeDuration.equals

TimeDuration.equals(other, rtol=None, atol=None, verbose=None, traceback=False)[source]

True if two time durations are equal.

New in version 1.0.

See also

equivalent

Parameters
other:

The object to compare for equality.

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 instances differ.

Returns
bool

Whether or not the two instances are equal.

Examples:

>>> t = cf.TimeDuration(36, 'calendar_months')
>>> u = cf.TimeDuration(3, 'calendar_years')
>>> t == u
True
>>> t.equals(u, traceback=True)
TimeDuration: Different durations: <CF Data: 36 calendar_months>, <CF Data: 3 calendar_years>
False