8000 Update guidance for linalg `rtol` tolerance cutoff to accommodate non… · data-apis/array-api@52905bf · GitHub
[go: up one dir, main page]
Skip to content

Commit 52905bf

Browse files
kgrytekgryte
authored
Update guidance for linalg rtol tolerance cutoff to accommodate non-SVD algorithms (#304)
For further discussion, see #216
1 parent 64c4c58 commit 52905bf

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

‎spec/extensions/linear_algebra_functions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ Returns the rank (i.e., number of non-zero singular values) of a matrix (or a st
345345

346346
- **rtol**: _Optional\[ Union\[ float, <array> ] ]_
347347

348-
- relative tolerance for small singular values. Singular values less than or equal to `rtol * largest_singular_value` are set to zero. If a `float`, the value is equivalent to a zero-dimensional array having a floating-point data type determined by {ref}`type-promotion` (as applied to `x`) and must be broadcast against each matrix. If an `array`, must have a floating-point data type and must be compatible with `shape(x)[:-2]` (see {ref}`broadcasting`). If `None`, the default value is `max(M, N) * eps`, where `eps` must be the machine epsilon associated with the floating-point data type determined by {ref}`type-promotion` (as applied to `x`). Default: `None`.
348+
- relative tolerance for small singular values. Singular values approximately less than or equal to `rtol * largest_singular_value` are set to zero. If a `float`, the value is equivalent to a zero-dimensional array having a floating-point data type determined by {ref}`type-promotion` (as applied to `x`) and must be broadcast against each matrix. If an `array`, must have a floating-point data type and must be compatible with `shape(x)[:-2]` (see {ref}`broadcasting`). If `None`, the default value is `max(M, N) * eps`, where `eps` must be the machine epsilon associated with the floating-point data type determined by {ref}`type-promotion` (as applied to `x`). Default: `None`.
349349

350350
#### Returns
351351

@@ -392,7 +392,7 @@ Returns the (Moore-Penrose) pseudo-inverse of a matrix (or a stack of matrices)
392392

393393
- **rtol**: _Optional\[ Union\[ float, <array> ] ]_
394394

395-
- relative tolerance for small singular values. Singular values less than or equal to `rtol * largest_singular_value` are set to zero. If a `float`, the value is equivalent to a zero-dimensional array having a floating-point data type determined by {ref}`type-promotion` (as applied to `x`) and must be broadcast against each matrix. If an `array`, must have a floating-point data type and must be compatible with `shape(x)[:-2]` (see {ref}`broadcasting`). If `None`, the default value is `max(M, N) * eps`, where `eps` must be the machine epsilon associated with the floating-point data type determined by {ref}`type-promotion` (as applied to `x`). Default: `None`.
395+
- relative tolerance for small singular values. Singular values approximately less than or equal to `rtol * largest_singular_value` are set to zero. If a `float`, the value is equivalent to a zero-dimensional array having a floating-point data type determined by {ref}`type-promotion` (as applied to `x`) and must be broadcast against each matrix. If an `array`, must have a floating-point data type and must be compatible with `shape(x)[:-2]` (see {ref}`broadcasting`). If `None`, the default value is `max(M, N) * eps`, where `eps` must be the machine epsilon associated with the floating-point data type determined by {ref}`type-promotion` (as applied to `x`). Default: `None`.
396396

397397
#### Returns
398398

0 commit comments

Comments
 (0)
0