Skip to content

Commit

Permalink
DOC: linalg: mention that eigenvalues_only=True/False may change the …
Browse files Browse the repository at this point in the history
…eigenvalues

[docs only]
  • Loading branch information
ev-br committed Mar 20, 2024
1 parent cc70c7b commit de96160
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions scipy/linalg/_decomp.py
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,11 @@ def eigh(a, b=None, *, lower=True, eigvals_only=False, overwrite_a=False,
often performs worse than the rest except when very few eigenvalues are
requested for large arrays though there is still no performance guarantee.
Note that the underlying LAPACK algorithms are different depending on whether
`eigvals_only` is True or False --- thus the eigenvalues may differ
depending on whether eigenvectors are requested or not. The difference is
generally of the order of machine epsilon, so is likely only visible
for zero or nearly zero eigenvalues.
For the generalized problem, normalization with respect to the given
type argument::
Expand Down

0 comments on commit de96160

Please sign in to comment.