You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: spec/extensions/linear_algebra_functions.md
+4-7Lines changed: 4 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -170,7 +170,7 @@ Returns the specified diagonals of a matrix (or a stack of matrices) `x`.
170
170
(function-linalg-eigh)=
171
171
### linalg.eigh(x, /)
172
172
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).
173
+
Returns an eigendecomposition 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).
174
174
175
175
<!-- 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 -->
176
176
@@ -192,7 +192,6 @@ Returns the eigenvalues and eigenvectors x = QLQᵀ of a symmetric matrix (or a
192
192
Each returned array must have the same floating-point data type as `x`.
193
193
194
194
```{note}
195
-
196
195
Eigenvalue sort order is left unspecified.
197
196
```
198
197
@@ -221,7 +220,6 @@ Returns the eigenvalues of a symmetric matrix (or a stack of symmetric matrices)
221
220
- an array containing the computed eigenvalues. The returned array must have shape `(..., M)` and have the same data type as `x`.
222
221
223
222
```{note}
224
-
225
223
Eigenvalue sort order is left unspecified.
226
224
```
227
225
@@ -395,13 +393,13 @@ Returns the (Moore-Penrose) pseudo-inverse of a matrix (or a stack of matrices)
395
393
(function-linalg-qr)=
396
394
### linalg.qr(x, /, *, mode='reduced')
397
395
398
-
Returns the qr decomposition x = QR of a matrix (or a stack of matrices)`x`, where `Q` is an orthonormal matrix (or a stack of matrices) and `R` is an upper-triangular matrix (or a stack of matrices).
396
+
Returns the qr decomposition x = QR of a full column rank matrix (or a stack of matrices), where `Q` is an orthonormal matrix (or a stack of matrices) and `R` is an upper-triangular matrix (or a stack of matrices).
399
397
400
398
#### Parameters
401
399
402
400
-**x**: _<array>_
403
401
404
-
- input array having shape `(..., M, N)` and whose innermost two dimensions form `MxN` matrices. Should have a floating-point data type.
402
+
- input array having shape `(..., M, N)` and whose innermost two dimensions form `MxN` matrices of rank equal to `N`. Should have a floating-point data type.
405
403
406
404
-**mode**: _Literal\[ 'reduced', 'complete' ]_
407
405
@@ -429,7 +427,6 @@ Returns the qr decomposition x = QR of a matrix (or a stack of matrices) `x`, wh
429
427
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`.
430
428
431
429
```{note}
432
-
433
430
The purpose of this function is to calculate the determinant more accurately when the determinant is either very small or very large, as calling `det` may overflow or underflow.
434
431
```
435
432
@@ -476,7 +473,7 @@ Returns the solution to the system of linear equations represented by the well-d
476
473
(function-linalg-svd)=
477
474
### linalg.svd(x, /, *, full_matrices=True)
478
475
479
-
Returns the singular value decomposition A = USVh of a matrix (or a stack of matrices) `x` where `U` is a matrix (or a stack of matrices) with orthonormal columns, `S` is a vector of non-negative numbers (or stack of vectors), and `Vh` is a matrix (or a stack of matrices) with orthonormal rows.
476
+
Returns a singular value decomposition A = USVh of a matrix (or a stack of matrices) `x`, where `U` is a matrix (or a stack of matrices) with orthonormal columns, `S` is a vector of non-negative numbers (or stack of vectors), and `Vh` is a matrix (or a stack of matrices) with orthonormal rows.
0 commit comments