8000 Add qualifiers · lezcano/array-api@6ae75cc · GitHub
[go: up one dir, main page]

Skip to content

Commit 6ae75cc

Browse files
authored
Add qualifiers
1 parent 8c30e4f commit 6ae75cc

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

spec/extensions/linear_algebra_functions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ Returns the specified diagonals of a matrix (or a stack of matrices) `x`.
170170
(function-linalg-eigh)=
171171
### linalg.eigh(x, /)
172172

173-
Returns the eigenvalues and eigenvectors x = QLQᵀ of a symmetric matrix (or a stack of matrices) `x`, where `Q` is an orthogonal matrix (or a stack of matrices) and `L` is a vector (or a stack of vectors).
173+
Returns the eigenvalues and eigenvectors x = QLQᵀ of a symmetric matrix (or a stack of symmetric matrices) `x`, where `Q` is an orthogonal matrix (or a stack of matrices) and `L` is a vector (or a stack of vectors).
174174

175175
<!-- NOTE: once complex number support, each matrix must be Hermitian and the returned Q unitary. We might also want to make the dtype of `eigenvalues` unconditionally real -->
176176

@@ -204,7 +204,7 @@ as it requires complex number support.
204204
(function-linalg-eigvalsh)=
205205
### linalg.eigvalsh(x, /)
206206

207-
Returns the eigenvalues of a symmetric matrix (or a stack of matrices) `x`.
207+
Returns the eigenvalues of a symmetric matrix (or a stack of symmetric matrices) `x`.
208208

209209
<!-- NOTE: once complex number support, each matrix must be Hermitian -->
210210

@@ -233,7 +233,7 @@ as it requires complex number support.
233233
(function-linalg-inv)=
234234
### linalg.inv(x, /)
235235

236-
Returns the multiplicative inverse of a square matrix (or a stack of matrices) `x`.
236+
Returns the multiplicative inverse of a square matrix (or a stack of square matrices) `x`.
237237

238238
#### Parameters
239239

@@ -306,7 +306,7 @@ Computes the matrix norm of a matrix (or a stack of matrices) `x`.
306306
(function-linalg-matrix_power)=
307307
### linalg.matrix_power(x, n, /)
308308

309-
Raises a square matrix (or a stack of matrices) `x` to an integer power `n`.
309+
Raises a square matrix (or a stack of square matrices) `x` to an integer power `n`.
310310

311311
#### Parameters
312312

@@ -418,15 +418,15 @@ Returns the qr decomposition x = QR of a matrix (or a stack of matrices) `x`, wh
418418

419419
- a namedtuple `(q, r)` whose
420420

421-
- first element must have the field name `q` and must be an array whose shape depends on the value of `mode` and contain matrices with orthonormal columns. If `mode` is `'complete'`, the array must have shape `(..., M, M)`. If `mode` is `'reduced'`, the array must have shape `(..., M, K)`, where `K = min(M, N)`. The first `x.ndim-2` dimensions must have the same size as those of the input `x`.
421+
- first element must have the field name `q` and must be an array whose shape depends on the value of `mode` and contain matrices with orthonormal columns. If `mode` is `'complete'`, the array must have shape `(..., M, M)`. If `mode` is `'reduced'`, the array must have shape `(..., M, K)`, where `K = min(M, N)`. The first `x.ndim-2` dimensions must have the same size as those of the input array `x`.
422422
- second element must have the field name `r` and must be an array whose shape depends on the value of `mode` and contain upper-triangular matrices. If `mode` is `'complete'`, the array must have shape `(..., M, M)`. If `mode` is `'reduced'`, the array must have shape `(..., K, N)`, where `K = min(M, N)`. The first `x.ndim-2` dimensions must have the same size as those of the input `x`.
423423

424424
Each returned array must have a floating-point data type determined by {ref}`type-promotion`.
425425

426426
(function-linalg-slogdet)=
427427
### linalg.slogdet(x, /)
428428

429-
Returns the sign and the natural logarithm of the absolute value of the determinant of a square matrix (or a stack of matrices) `x`.
429+
Returns the sign and the natural logarithm of the absolute value of the determinant of a square matrix (or a stack of square matrices) `x`.
430430

431431
```{note}
432432

0 commit comments

Comments
 (0)
0