Skip to content

eigvalsh#

Includes our eigvalsh bindings.

Functions:

  • eigvalsh –

    Compute eigenvalues of a hermitain generalized eigenvalue problem.

eigvalsh #

eigvalsh(A: NDArray, B: NDArray | None = None, compute_module: str = 'cupy', output_module: str | None = None, use_pinned_memory: bool = True) -> NDArray

Compute eigenvalues of a hermitain generalized eigenvalue problem.

TODO: only type 1 generalized problems are supported, Only a subset of keywords of scipy.linalg.eigvalsh are supported.

Parameters:

  • A (NDArray) –

    A complex or real symmetric or hermitian matrix.

  • B (NDArray, default: None ) –

    A complex or real symmetric or hermitian positive definite matrix. If omitted, identity matrix is assumed.

  • compute_module (str, default: 'cupy' ) –

    The location where to compute the eigenvalues.

  • output_module (str, default: None ) –

    The location where to store the resulting eigenvalues.

  • use_pinned_memory (bool, default: True ) –

    Whether to use pinnend memory if cupy is used. Default is True.

Returns:

  • NDArray –

    The eigenvalues of the generalized eigenvalue problem.