Python PyTorch eigvalsh用法及代码示例

本文简要介绍python语言中 torch.linalg.eigvalsh 的用法。

用法:

torch.linalg.eigvalsh(A, UPLO='L', *, out=None) → Tensor

参数：

• A(Tensor) -形状为 (*, n, n) 的张量，其中 * 是零个或多个由对称或 Hermitian 矩阵组成的批次维度。

• UPLO('L','U',可选的) -控制在计算中是使用A 的上三角部分还是下三角部分。默认值：‘L’。

关键字参数：

out(Tensor,可选的) -输出张量。如果 None 则忽略。默认值：None。

返回：

即使A 是复数，实值张量也包含特征值。特征值按升序返回。

计算复数 Hermitian 或实对称矩阵的特征值。

让\mathbb{K}是\mathbb{R}或者\mathbb{C}， 这特征值复 Hermitian 或实对称矩阵的A \in \mathbb{K}^{n \times n}被定义为多项式的根(以重数计算)p学位n由

p(\lambda) = \operatorname{det}(A - \lambda \mathrm{I}_n)\mathrlap{\qquad \lambda \in \mathbb{R}}

其中 \mathrm{I}_n 是 n 维单位矩阵。实对称或复 Hermitian 矩阵的特征值始终为实数。

支持 float、double、cfloat 和 cdouble dtypes 的输入。还支持批量矩阵，如果 A 是批量矩阵，则输出具有相同的批量维度。

特征值按升序返回。

A 被假定为 Hermitian (resp. 对称)，但内部并未对此进行检查，而是：

• 如果UPLO = ‘L’(默认)，则仅在计算中使用矩阵的下三角部分。

• 如果 UPLO = ‘U’ ，则仅使用矩阵的上三角部分。

注意

当输入在 CUDA 设备上时，此函数将该设备与 CPU 同步。

例子：

>>> A = torch.randn(2, 2, dtype=torch.complex128)
>>> A = A + A.T.conj()  # creates a Hermitian matrix
>>> A
tensor([[2.9228+0.0000j, 0.2029-0.0862j],
        [0.2029+0.0862j, 0.3464+0.0000j]], dtype=torch.complex128)
>>> torch.linalg.eigvalsh(A)
tensor([0.3277, 2.9415], dtype=torch.float64)

>>> A = torch.randn(3, 2, 2, dtype=torch.float64)
>>> A = A + A.transpose(-2, -1)  # creates a batch of symmetric matrices
>>> torch.linalg.eigvalsh(A)
tensor([[ 2.5797,  3.4629],
        [-4.1605,  1.3780],
        [-3.1113,  2.7381]], dtype=torch.float64)