is_dimensionless

class brainunit.math.is_dimensionless(obj)

Test if a value is dimensionless or not.

Parameters:

obj (saiunit.Quantity | saiunit.Unit | saiunit.Dimension | Array | ndarray | bool | number | bool | int | float | complex) – The object to check.

Returns:

dimensionless – True if obj is dimensionless.

Return type:

bool

See also

is_unitless

Check whether the object is unitless.

Examples

>>> import saiunit as u
>>> u.is_dimensionless(5.0)
True
>>> u.is_dimensionless(5.0 * u.volt)
False
>>> u.is_dimensionless(u.DIMENSIONLESS)
True