numpy.array_api.linalg

module documentation

Undocumented

Class	`EighResult`	Undocumented
Class	`QRResult`	Undocumented
Class	`SlogdetResult`	Undocumented
Class	`SVDResult`	Undocumented
Function	`_solve`	Undocumented
Function	`cholesky`	Array API compatible wrapper for `np.linalg.cholesky`.
Function	`cross`	Array API compatible wrapper for `np.cross`.
Function	`det`	Array API compatible wrapper for `np.linalg.det`.
Function	`diagonal`	Array API compatible wrapper for `np.diagonal`.
Function	`eigh`	Array API compatible wrapper for `np.linalg.eigh`.
Function	`eigvalsh`	Array API compatible wrapper for `np.linalg.eigvalsh`.
Function	`inv`	Array API compatible wrapper for `np.linalg.inv`.
Function	`matmul`	Array API compatible wrapper for `np.matmul`.
Function	`matrix_norm`	Array API compatible wrapper for `np.linalg.norm`.
Function	`matrix_power`	Array API compatible wrapper for `np.matrix_power`.
Function	`matrix_rank`	Array API compatible wrapper for `np.matrix_rank`.
Function	`matrix_transpose`	Undocumented
Function	`outer`	Array API compatible wrapper for `np.outer`.
Function	`pinv`	Array API compatible wrapper for `np.linalg.pinv`.
Function	`qr`	Array API compatible wrapper for `np.linalg.qr`.
Function	`slogdet`	Array API compatible wrapper for `np.linalg.slogdet`.
Function	`solve`	Array API compatible wrapper for `np.linalg.solve`.
Function	`svd`	Array API compatible wrapper for `np.linalg.svd`.
Function	`svdvals`	Undocumented
Function	`tensordot`	Undocumented
Function	`trace`	Array API compatible wrapper for `np.trace`.
Function	`vecdot`	Undocumented
Function	`vector_norm`	Array API compatible wrapper for `np.linalg.norm`.

def _solve(a, b):

Undocumented

def cholesky(x, /, *, upper=False):

Array API compatible wrapper for np.linalg.cholesky.

See its docstring for more information.

Parameters
x:`Array`	Undocumented
upper:`bool`	Undocumented
Returns
`Array`	Undocumented

def cross(x1, x2, /, *, axis=-1):

Array API compatible wrapper for np.cross.

See its docstring for more information.

Parameters
x1:`Array`	Undocumented
x2:`Array`	Undocumented
axis:`int`	Undocumented
Returns
`Array`	Undocumented

def det(x, /):

Array API compatible wrapper for np.linalg.det.

See its docstring for more information.

Parameters
x:`Array`	Undocumented
Returns
`Array`	Undocumented

def diagonal(x, /, *, offset=0):

Array API compatible wrapper for np.diagonal.

See its docstring for more information.

Parameters
x:`Array`	Undocumented
offset:`int`	Undocumented
Returns
`Array`	Undocumented

def eigh(x, /):

Array API compatible wrapper for np.linalg.eigh.

See its docstring for more information.

Parameters
x:`Array`	Undocumented
Returns
`EighResult`	Undocumented

def eigvalsh(x, /):

Array API compatible wrapper for np.linalg.eigvalsh.

See its docstring for more information.

Parameters
x:`Array`	Undocumented
Returns
`Array`	Undocumented

def inv(x, /):

Array API compatible wrapper for np.linalg.inv.

See its docstring for more information.

Parameters
x:`Array`	Undocumented
Returns
`Array`	Undocumented

def matmul(x1, x2, /):

Array API compatible wrapper for np.matmul.

See its docstring for more information.

Parameters
x1:`Array`	Undocumented
x2:`Array`	Undocumented
Returns
`Array`	Undocumented

def matrix_norm(x, /, *, keepdims=False, ord='fro'):

Array API compatible wrapper for np.linalg.norm.

See its docstring for more information.

Parameters
x:`Array`	Undocumented
keepdims:`bool`	Undocumented
ord:`Optional[Union[int, float, Literal['fro', 'nuc']]]`	Undocumented
Returns
`Array`	Undocumented

def matrix_power(x, n, /):

Array API compatible wrapper for np.matrix_power.

See its docstring for more information.

Parameters
x:`Array`	Undocumented
n:`int`	Undocumented
Returns
`Array`	Undocumented

def matrix_rank(x, /, *, rtol=None):

Array API compatible wrapper for np.matrix_rank.

See its docstring for more information.

Parameters
x:`Array`	Undocumented
rtol:`Optional[Union[float, Array]]`	Undocumented
Returns
`Array`	Undocumented

def matrix_transpose(x, /):

Undocumented

Parameters
x:`Array`	Undocumented
Returns
`Array`	Undocumented

def outer(x1, x2, /):

Array API compatible wrapper for np.outer.

See its docstring for more information.

Parameters
x1:`Array`	Undocumented
x2:`Array`	Undocumented
Returns
`Array`	Undocumented

def pinv(x, /, *, rtol=None):

Array API compatible wrapper for np.linalg.pinv.

See its docstring for more information.

Parameters
x:`Array`	Undocumented
rtol:`Optional[Union[float, Array]]`	Undocumented
Returns
`Array`	Undocumented

def qr(x, /, *, mode='reduced'):

Array API compatible wrapper for np.linalg.qr.

See its docstring for more information.

Parameters
x:`Array`	Undocumented
mode:`Literal['reduced', 'complete']`	Undocumented
Returns
`QRResult`	Undocumented

def slogdet(x, /):

Array API compatible wrapper for np.linalg.slogdet.

See its docstring for more information.

Parameters
x:`Array`	Undocumented
Returns
`SlogdetResult`	Undocumented

def solve(x1, x2, /):

Array API compatible wrapper for np.linalg.solve.

See its docstring for more information.

Parameters
x1:`Array`	Undocumented
x2:`Array`	Undocumented
Returns
`Array`	Undocumented

def svd(x, /, *, full_matrices=True):

Array API compatible wrapper for np.linalg.svd.

See its docstring for more information.

Parameters
x:`Array`	Undocumented
full_matrices:`bool`	Undocumented
Returns
`SVDResult`	Undocumented

def svdvals(x, /):

Undocumented

Parameters
x:`Array`	Undocumented
Returns
`Union[Array, Tuple[Array, ...]]`	Undocumented

def tensordot(x1, x2, /, *, axes=2):

Undocumented

Parameters
x1:`Array`	Undocumented
x2:`Array`	Undocumented
axes:`Union[int, Tuple[Sequence[int], Sequence[int]]]`	Undocumented
Returns
`Array`	Undocumented

def trace(x, /, *, offset=0):

Array API compatible wrapper for np.trace.

See its docstring for more information.

Parameters
x:`Array`	Undocumented
offset:`int`	Undocumented
Returns
`Array`	Undocumented

def vecdot(x1, x2, /, *, axis=-1):

Undocumented

Parameters
x1:`Array`	Undocumented
x2:`Array`	Undocumented
axis:`int`	Undocumented
Returns
`Array`	Undocumented

def vector_norm(x, /, *, axis=None, keepdims=False, ord=2):

Array API compatible wrapper for np.linalg.norm.

See its docstring for more information.

Parameters
x:`Array`	Undocumented
axis:`Optional[Union[int, Tuple[int, int]]]`	Undocumented
keepdims:`bool`	Undocumented
ord:`Optional[Union[int, float]]`	Undocumented
Returns
`Array`	Undocumented