numpy.diagonal#

numpy.diagonal(a, offset=0, axis1=0, axis2=1)[源]#

返回指定的对角线。

如果 a 是二维数组，则返回 a 具有给定偏移量的对角线，即形式为 a[i, i+offset] 的元素集合。如果 a 具有两个以上的维度，则由 axis1 和 axis2 指定的轴用于确定返回其对角线的二维子数组。结果数组的形状可以通过移除 axis1 和 axis2 并在右侧追加一个等于结果对角线大小的索引来确定。

在 NumPy 1.7 之前的版本中，此函数始终返回一个新的、独立的数组，其中包含对角线值的副本。

在 NumPy 1.7 和 1.8 中，它继续返回对角线的副本，但依赖此事实已被弃用。写入结果数组仍然像以前一样有效，但会发出一个 FutureWarning。

从 NumPy 1.9 开始，它返回原始数组的一个只读视图。尝试写入结果数组将产生错误。

在未来的某个版本中，它将返回一个读/写视图，并且写入返回的数组将修改您的原始数组。返回的数组将与输入数组具有相同的类型。

如果您不写入此函数返回的数组，那么您可以忽略上述所有内容。

如果您依赖当前行为，我们建议显式复制返回的数组，即使用 np.diagonal(a).copy() 而不是仅仅使用 np.diagonal(a)。这在 NumPy 的过去和未来版本中都将有效。

参数：
aarray_like

从中提取对角线的数组。

offsetint, 可选

对角线相对于主对角线的偏移量。可以是正值或负值。默认为主对角线 (0)。

axis1int, 可选

用作提取对角线的二维子数组的第一个轴。默认为第一个轴 (0)。

axis2int, 可选

用作提取对角线的二维子数组的第二个轴。默认为第二个轴 (1)。

返回：
array_of_diagonalsndarray

如果 a 是二维数组，则返回一个包含对角线且与 a 类型相同的 一维数组，除非 a 是一个 matrix，在这种情况下，为了保持向后兼容性，将返回一个一维数组而不是 (二维) matrix。

如果 a.ndim > 2，则由 axis1 和 axis2 指定的维度将被移除，并在末尾插入一个对应于对角线的新轴。

引发：
ValueError

如果 a 的维度小于 2。

另请参阅

diag

1D 和 2D 数组的 MATLAB 类似功能。

diagflat

创建对角数组。

trace

沿对角线求和。

示例

>>> import numpy as np
>>> a = np.arange(4).reshape(2,2)
>>> a
array([[0, 1],
       [2, 3]])
>>> a.diagonal()
array([0, 3])
>>> a.diagonal(1)
array([1])

一个三维示例

>>> a = np.arange(8).reshape(2,2,2); a
array([[[0, 1],
        [2, 3]],
       [[4, 5],
        [6, 7]]])
>>> a.diagonal(0,  # Main diagonals of two arrays created by skipping
...            0,  # across the outer(left)-most axis last and
...            1)  # the "middle" (row) axis first.
array([[0, 6],
       [1, 7]])

我们刚刚获得主对角线的子数组；请注意，每个子数组都对应于固定最右侧（列）轴，并且对角线以行的方式“打包”。

>>> a[:,:,0]  # main diagonal is [0 6]
array([[0, 2],
       [4, 6]])
>>> a[:,:,1]  # main diagonal is [1 7]
array([[1, 3],
       [5, 7]])

可以通过使用 numpy.flipud 或 numpy.fliplr 反转元素顺序来获得反对角线。

>>> a = np.arange(9).reshape(3, 3)
>>> a
array([[0, 1, 2],
       [3, 4, 5],
       [6, 7, 8]])
>>> np.fliplr(a).diagonal()  # Horizontal flip
array([2, 4, 6])
>>> np.flipud(a).diagonal()  # Vertical flip
array([6, 4, 2])

请注意，对角线的检索顺序因翻转函数而异。

在此页面上