Document feedback

Question document fragment

When a question document fragment contains a formula, it is displayed as a space.

Submission type

issue

It's a little complicated...

I'd like to ask someone.

PR

Just a small problem.

I can fix it online!

Please select the submission type

Problem type

Specifications and Common Mistakes

- Specifications and Common Mistakes:

- Misspellings or punctuation mistakes,incorrect formulas, abnormal display.

- Incorrect links, empty cells, or wrong formats.

- Chinese characters in English context.

- Minor inconsistencies between the UI and descriptions.

- Low writing fluency that does not affect understanding.

- Incorrect version numbers, including software package names and version numbers on the UI.

Usability

- Usability:

- Incorrect or missing key steps.

- Missing main function descriptions, keyword explanation, necessary prerequisites, or precautions.

- Ambiguous descriptions, unclear reference, or contradictory context.

- Unclear logic, such as missing classifications, items, and steps.

Correctness

- Correctness:

- Technical principles, function descriptions, supported platforms, parameter types, or exceptions inconsistent with that of software implementation.

- Incorrect schematic or architecture diagrams.

- Incorrect commands or command parameters.

- Incorrect code.

- Commands inconsistent with the functions.

- Wrong screenshots.

- Sample code running error, or running results inconsistent with the expectation.

Risk Warnings

- Risk Warnings:

- Lack of risk warnings for operations that may damage the system or important data.

Content Compliance

- Content Compliance:

- Contents that may violate applicable laws and regulations or geo-cultural context-sensitive words and expressions.

- Copyright infringement.

Please select the type of question

Problem description

Describe the bug so that we can quickly locate the problem.

Submit

Document feedback

mindspore.scipy.linalg.eigh

mindspore.scipy.linalg.eigh(a, b=None, lower=True, eigvals_only=False, overwrite_a=False, overwrite_b=False, turbo=True, eigvals=None, type=1, check_finite=True)

Solve a standard or generalized eigenvalue problem for a complex Hermitian or real symmetric matrix.

Find eigenvalues Tensor w and optionally eigenvectors Tensor v of Tensor a, where b is positive definite such that for every eigenvalue λ (i-th entry of w) and its eigenvector vi (i-th column of v) satisfies:

              a @ vi = λ * b @ vi
vi.conj().T @ a @ vi = λ
vi.conj().T @ b @ vi = 1

In the standard problem, b is assumed to be the identity matrix.

Note

• eigh is not supported on Windows platform yet.

• Only float32, float64, int32, int64 are supported Tensor dtypes.

• If Tensor with dtype int32 or int64 is passed, it will be cast to mstype.float64.

Parameters

• a (Tensor) – A $(M,M)$ complex Hermitian or real symmetric matrix whose eigenvalues and eigenvectors will be computed.

• b (Tensor, optional) – A $(M,M)$ complex Hermitian or real symmetric definite positive matrix in. If omitted, identity matrix is assumed. Default: None.

• lower (bool, optional) – Whether the pertinent Tensor data is taken from the lower or upper triangle of a and, if applicable, b. Default: True.

• eigvals_only (bool, optional) – Whether to calculate only eigenvalues and no eigenvectors. Default: False .

• overwrite_a (bool, optional) – Whether to overwrite data in a (may improve performance). Default: False .

• overwrite_b (bool, optional) – Whether to overwrite data in b (may improve performance). Default: False .

• turbo (bool, optional) – use divide and conquer algorithm (faster but expensive in memory, only for generalized eigenvalue problem and if full set of eigenvalues are requested.). Has no significant effect if eigenvectors are not requested. Default: True .

• eigvals (tuple, optional) – Indexes of the smallest and largest (in ascending order) eigenvalues and corresponding eigenvectors to be returned: $0<=lo<=hi<=M-1$. If omitted, all eigenvalues and eigenvectors are returned. Default: None .

• type (int, optional) –

  For the generalized problems, this keyword specifies the problem type to be solved for w and v (only takes 1, 2, 3 as possible inputs):

  1 =>     a @ v = w @ b @ v
  2 => a @ b @ v = w @ v
  3 => b @ a @ v = w @ v
  

  This keyword is ignored for standard problems. Default: 1 .

• check_finite (bool, optional) – Whether to check that the input matrices contain only finite numbers. Disabling may give a performance gain, but may result in problems (crashes, non-termination) if the inputs do contain infinities or NaNs. Default: True .

Returns

• Tensor with shape $(N,)$, the $N(1<=N<=M)$ selected eigenvalues, in ascending order, each repeated according to its multiplicity.

• Tensor with shape $(M,N)$, if eigvals_only == False.

Raises

• RuntimeError – If eigenvalue computation does not converge, an error occurred, or b matrix is not definite positive. Note that if input matrices are not symmetric or Hermitian, no error will be reported but results will be wrong.

• TypeError – If a is not Tensor.

• TypeError – If lower is not bool.

• TypeError – If eigvals_only is not bool.

• TypeError – If overwrite_a is not bool.

• TypeError – If overwrite_b is not bool.

• TypeError – If turbo is not bool.

• TypeError – If check_finite is not bool.

• ValueError – If a is not 2D square matrix.

• ValueError – If b is not None.

• ValueError – If eigvals is not None.

Supported Platforms:

GPU CPU

Examples

>>> import numpy as onp
>>> import mindspore.numpy as mnp
>>> from mindspore import Tensor, dtype
>>> from mindspore.scipy.linalg import eigh
>>> a = Tensor([[6, 3, 1, 5], [3, 0, 5, 1], [1, 5, 6, 2], [5, 1, 2, 2]], dtype.float64)
>>> w, v = eigh(a)
>>> print(onp.allclose(mnp.dot(a, v).asnumpy(), mnp.dot(v, mnp.diag(w)).asnumpy(), 1e-5, 1e-8))
True