Skip to content

Commit

Permalink
DOC Update doc for the argument sortin linalg.schur. (scipy#20906)
Browse files Browse the repository at this point in the history
  • Loading branch information
m-maggi authored Jun 6, 2024
1 parent 59d8ebc commit de85b05
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions scipy/linalg/_decomp_schur.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ def schur(a, output='real', lwork=None, overwrite_a=False, sort=None,
Specifies whether the upper eigenvalues should be sorted. A callable
may be passed that, given a eigenvalue, returns a boolean denoting
whether the eigenvalue should be sorted to the top-left (True).
If output='real', the callable should have two arguments, the first
one being the real part of the eigenvalue, the second one being
the imaginary part.
Alternatively, string parameters may be used::
'lhp' Left-hand plane (x.real < 0.0)
Expand Down

0 comments on commit de85b05

Please sign in to comment.