Skip to content

Commit 46a7ec2

Browse files
committed
document real eigenvalues case
1 parent 589d94d commit 46a7ec2

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

doc/specs/stdlib_linalg.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1003,7 +1003,7 @@ The results are returned in output matrices \( T \) and \( Z \). Matrix \( T \)
10031003

10041004
- `z`: Shall be a rank-2 array of the same kind as `a`, containing the unitary matrix \( Z \). It is an `intent(out)` argument and is optional. If provided, it should have the shape `[n,n]`.
10051005

1006-
- `eigvals` (optional): Shall be a rank-1 `complex` array containing the eigenvalues of \( A \) (the diagonal elements of \( T \)). The array must be of size `[n]`. If not provided, the eigenvalues are not returned.
1006+
- `eigvals` (optional): Shall be a rank-1 `complex` or `real` array of the same kind as `a`, containing the eigenvalues of \( A \) (the diagonal elements of \( T \)), or their `real` component only. The array must be of size `[n]`. If not provided, the eigenvalues are not returned. It is an `intent(out)` argument.
10071007

10081008
- `overwrite_a` (optional): Shall be a `logical` flag (default: `.false.`). If `.true.`, the input matrix `a` will be overwritten and destroyed upon return, avoiding internal data allocation. It is an `intent(in)` argument.
10091009

@@ -1016,6 +1016,7 @@ The results are returned in output matrices \( T \) and \( Z \). Matrix \( T \)
10161016
Returns the Schur decomposition matrices into the \( T \) and \( Z \) arguments. If `eigvals` is provided, it will also return the eigenvalues of the matrix \( A \).
10171017

10181018
Raises `LINALG_VALUE_ERROR` if any of the matrices have invalid or unsuitable size for the decomposition.
1019+
Raises `LINALG_VALUE_ERROR` if the `real` component is only requested, but the eigenvalues have non-trivial imaginary parts.
10191020
Raises `LINALG_ERROR` on insufficient user storage space.
10201021
If the state argument `err` is not present, exceptions trigger an `error stop`.
10211022

0 commit comments

Comments
 (0)