is_unitless

Contents

is_unitless#

class brainunit.math.is_unitless(obj)#

Test if a value is unitless or not.

Parameters:

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

Returns:

unitless – True if obj is unitless.

Return type:

bool

Raises:

TypeError – If obj is a Dimension instance (dimensions do not carry a unit).

See also

is_dimensionless

Check whether the object is dimensionless.

Examples

>>> import saiunit as u
>>> u.is_unitless(5.0)
True
>>> u.is_unitless(5.0 * u.volt)
False
Contents