`scipy._lib.array_api_extra._delegation:create_diagonal`

Signature

   def     create_diagonal (    x  :  Array    ,  / ,     offset  :  int    =  0   ,    xp  :  ModuleType | None    =  None     )   →  Array

Construct a diagonal array.

x : array: An array having shape (*batch_dims, k).
offset : int, optional: Offset from the leading diagonal (default is 0). Use positive ints for diagonals above the leading diagonal, and negative ints for diagonals below the leading diagonal.
xp : array_namespace, optional: The standard-compatible namespace for x. Default: infer.

: array: An array having shape (*batch_dims, k+abs(offset), k+abs(offset)) with x on the diagonal (offset by offset).

import array_api_strict as xp
import array_api_extra as xpx
x = xp.asarray([2, 4, 8])

⚠

xpx.create_diagonal(x, xp=xp)

⚠

xpx.create_diagonal(x, offset=-2, xp=xp)

⚠