Skip to content

Change to full_matrices=False by default #225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions spec/extensions/linear_algebra_functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -549,7 +549,7 @@ Returns the solution to the system of linear equations represented by the well-d
- an array containing the solution to the system `AX = B` for each square matrix. The returned array must have the same shape as `x2` (i.e., the array corresponding to `B`) and must have a floating-point data type determined by {ref}`type-promotion`.

(function-linalg-svd)=
### linalg.svd(x, /, *, full_matrices=True)
### linalg.svd(x, /, *, full_matrices=False)

Computes the singular value decomposition `A = USV` of a matrix (or a stack of matrices) `x`.

Expand All @@ -561,7 +561,7 @@ Computes the singular value decomposition `A = USV` of a matrix (or a stack of m

- **full_matrices**: _bool_

- If `True`, compute full-sized `u` and `v`, such that `u` has shape `(..., M, M)` and `v` has shape `(..., N, N)`. If `False`, compute on the leading `K` singular vectors, such that `u` has shape `(..., M, K)` and `v` has shape `(..., K, N)` and where `K = min(M, N)`. Default: `True`.
- If `True`, compute full-sized `u` and `v`, such that `u` has shape `(..., M, M)` and `v` has shape `(..., N, N)`. If `False`, compute on the leading `K` singular vectors, such that `u` has shape `(..., M, K)` and `v` has shape `(..., K, N)` and where `K = min(M, N)`. Default: `False`.

#### Returns

Expand Down Expand Up @@ -648,4 +648,4 @@ Alias for {ref}`function-transpose`.
(function-linalg-vecdot)=
### linalg.vecdot(x1, x2, /, *, axis=None)

Alias for {ref}`function-vecdot`.
Alias for {ref}`function-vecdot`.