Skip to content

Commit b0b23be

Browse files
lezcanokgryte
andauthored
Remove upper keyword from eigh and eigvalsh. (#226)
* Remove upper keyword * Ensure arguments are positional-only Co-authored-by: Athan <kgryte@gmail.com>
1 parent 5593253 commit b0b23be

File tree

1 file changed

+2
-10
lines changed

1 file changed

+2
-10
lines changed

spec/extensions/linear_algebra_functions.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ Returns the specified diagonals of a matrix (or a stack of matrices) `x`.
172172
_TODO: this requires complex number support to be added to the specification._
173173

174174
(function-linalg-eigh)=
175-
### linalg.eigh(x, /, *, upper=False)
175+
### linalg.eigh(x, /)
176176

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

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

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

187-
- **upper**: _bool_
188-
189-
- 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`.
190-
191187
#### Returns
192188

193189
- **out**: _Tuple\[ &lt;array&gt; ]_
@@ -210,7 +206,7 @@ Eigenvalue sort order is left unspecified.
210206
_TODO: this requires complex number support to be added to the specification._
211207

212208
(function-linalg-eigvalsh)=
213-
### linalg.eigvalsh(x, /, *, upper=False)
209+
### linalg.eigvalsh(x, /)
214210

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

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

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

225-
- **upper**: _bool_
226-
227-
- If `True`, use the upper-triangular part to compute the eigenvalues. If `False`, use the lower-triangular part to compute the eigenvalues. Default: `False`.
228-
229221
#### Returns
230222

231223
- **out**: _&lt;array&gt;_

0 commit comments

Comments
 (0)