jax.lax.linalg.eigh
Warning
This page was created from a pull request (#9655).
jax.lax.linalg.eighΒΆ
- jax.lax.linalg.eigh(x, lower=True, symmetrize_input=True)[source]ΒΆ
Eigendecomposition of a Hermitian matrix.
Computes the eigenvectors and eigenvalues of a complex Hermitian or real symmetric square matrix.
- Parameters
x β A batch of square complex Hermitian or real symmetric matrices with shape
[..., n, n]
.lower (
bool
) β Ifsymmetrize_input
isFalse
, describes which triangle of the input matrix to use. Ifsymmetrize_input
isFalse
, only the triangle given bylower
is accessed; the other triangle is ignored and not accessed.symmetrize_input (
bool
) β IfTrue
, the matrix is symmetrized before the eigendecomposition by computing \(\frac{1}{2}(x + x^H)\).
- Returns
A tuple
(w, v)
.w
is an array with the same dtype asx
such thatw[..., :, i]
is the eigenvector corresponding tov[..., i]
.v
is an array with the same dtype asx
(or its real counterpart if complex) with shape[..., n]
containing the eigenvalues ofx
.