atleast_3d

Contents

atleast_3d#

class brainunit.math.atleast_3d(*arys, **kwargs)#

View inputs as quantities or arrays with at least three dimensions.

Parameters:

*arys (Array | saiunit.Quantity) – One or more input arrays or quantities.

Returns:

res – An array or a quantity, or a tuple of arrays or quantities, each with a.ndim >= 3.

Return type:

saiunit.Quantity | Array | Sequence[saiunit.Quantity | Array]

Examples

>>> import saiunit as u
>>> a = [[1, 2], [3, 4]] * u.meter
>>> u.math.atleast_3d(a)
Contents