Skip to content

Remove upper keyword from eigh and eigvalsh. #226

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Sep 20, 2021
Merged

Remove upper keyword from eigh and eigvalsh. #226

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
85f99f0
Remove upper keyword
lezcano Jul 14, 2021
9fcf96e
Ensure arguments are positional-only
kgryte Jul 15, 2021
093b226
Merge branch 'main' into 217
kgryte Sep 20, 2021
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
12 changes: 2 additions & 10 deletions spec/extensions/linear_algebra_functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ Returns the specified diagonals of a matrix (or a stack of matrices) `x`.
_TODO: this requires complex number support to be added to the specification._

(function-linalg-eigh)=
### linalg.eigh(x, /, *, upper=False)
### linalg.eigh(x, /)

Returns the eigenvalues and eigenvectors of a symmetric matrix (or a stack of symmetric matrices) `x`.

Expand All @@ -184,10 +184,6 @@ Returns the eigenvalues and eigenvectors of a symmetric matrix (or a stack of sy

- input array having shape `(..., M, M)` and whose innermost two dimensions form square matrices. Must have a floating-point data type.

- **upper**: _bool_

- If `True`, use the upper-triangular part to compute the eigenvalues and eigenvectors. If `False`, use the lower-triangular part to compute the eigenvalues and eigenvectors. Default: `False`.

#### Returns

- **out**: _Tuple\[ <array> ]_
Expand All @@ -210,7 +206,7 @@ Eigenvalue sort order is left unspecified.
_TODO: this requires complex number support to be added to the specification._

(function-linalg-eigvalsh)=
### linalg.eigvalsh(x, /, *, upper=False)
### linalg.eigvalsh(x, /)

Computes the eigenvalues of a symmetric matrix (or a stack of symmetric matrices) `x`.

Expand All @@ -222,10 +218,6 @@ Computes the eigenvalues of a symmetric matrix (or a stack of symmetric matrices

- input array having shape `(..., M, M)` and whose innermost two dimensions form square matrices. Must have a floating-point data type.

- **upper**: _bool_

- If `True`, use the upper-triangular part to compute the eigenvalues. If `False`, use the lower-triangular part to compute the eigenvalues. Default: `False`.

#### Returns

- **out**: _<array>_
Expand Down