atleast_2d

Contents

atleast_2d#

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

View inputs as quantities or arrays with at least two 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 >= 2.

Return type:

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

Examples

>>> import saiunit as u
>>> a = [1, 2, 3] * u.second
>>> u.math.atleast_2d(a)
Contents