pyunitwizard.similarity#

pyunitwizard.similarity(quantity_or_unit_1, quantity_or_unit_2, relative_tolerance=1e-08)[source]#

Compare two quantities using relative tolerance semantics.

Parameters:

quantity_or_unit_1 (QuantityOrUnit) – First quantity or unit to compare.
quantity_or_unit_2 (QuantityOrUnit) – Second quantity or unit to compare.
relative_tolerance (float, default=1e-8) – Relative tolerance used internally as rtol in are_close().

Returns:

True when values are close within tolerance and units are compatible.

Return type:

bool

Examples

>>> import pyunitwizard as puw
>>> a = puw.quantity(1.0, "nanometer")
>>> b = puw.quantity(10.0, "angstrom")
>>> puw.similarity(a, b)