brainunit.is_scalar_type

Contents

brainunit.is_scalar_type#

brainunit.is_scalar_type(obj)#

Test whether obj is a scalar (0-d) numeric type.

Returns True for plain Python scalars (int, float) and 0-d unitless Quantity values. Strings and arrays with ndim > 0 return False.

Parameters:

obj (object) – The object to check.

Returns:

scalar – True if obj is a scalar that can be interpreted as a dimensionless Quantity.

Return type:

bool

Examples

>>> import saiunit as u
>>> u.is_scalar_type(5)
True
>>> u.is_scalar_type(5.0 * u.volt)
False
>>> u.is_scalar_type("hello")
False
Contents