`scipy._lib.array_api_extra._delegation:atleast_nd`

Signature

   def     atleast_nd (    x  :  Array    ,  / ,     ndim  :  int    ,    xp  :  ModuleType | None    =  None     )   →  Array

Recursively expand the dimension of an array to at least ndim.

x : array: Input array.
ndim : int: The minimum number of dimensions for the result.
xp : array_namespace, optional: The standard-compatible namespace for x. Default: infer.

: array: An array with res.ndim >= ndim. If x.ndim >= ndim, x is returned. If x.ndim < ndim, x is expanded by prepending new axes until res.ndim equals ndim.

import array_api_strict as xp
import array_api_extra as xpx
x = xp.asarray([1])
xpx.atleast_nd(x, ndim=3, xp=xp)

⚠

x = xp.asarray([[[1, 2],
                 [3, 4]]])
xpx.atleast_nd(x, ndim=1, xp=xp) is x

⚠