torch.sparse.spdiags

torch.sparse.spdiags(diagonals, offsets, shape, layout=None) → Tensor

通过将 diagonals 的行的值放置到输出的指定对角线上，创建一个稀疏的 2D 张量

offsets 张量控制设置哪些对角线。

• 如果 offsets[i] = 0，则为主对角线

• 如果 offsets[i] < 0，则在主对角线下方

• 如果 offsets[i] > 0，则在主对角线上方

diagonals 中的行数必须与 offsets 的长度匹配，并且偏移量不能重复。

参数

• diagonals (Tensor) – 行存储对角线的矩阵

• offsets (Tensor) – 要设置的对角线，存储为向量

• shape (2 元组 of 整数) – 结果所需的形状

关键字参数

layout (torch.layout，可选) – 返回张量的所需布局。支持 torch.sparse_coo、torch.sparse_csc 和 torch.sparse_csr。默认值：torch.sparse_coo

示例

设置矩阵的主对角线和前两个下对角线

>>> diags = torch.arange(9).reshape(3, 3)
>>> diags
tensor([[0, 1, 2],
        [3, 4, 5],
        [6, 7, 8]])
>>> s = torch.sparse.spdiags(diags, torch.tensor([0, -1, -2]), (3, 3))
>>> s
tensor(indices=tensor([[0, 1, 2, 1, 2, 2],
                       [0, 1, 2, 0, 1, 0]]),
       values=tensor([0, 1, 2, 3, 4, 6]),
       size=(3, 3), nnz=6, layout=torch.sparse_coo)
>>> s.to_dense()
tensor([[0, 0, 0],
        [3, 1, 0],
        [6, 4, 2]])

更改输出布局

>>> diags = torch.arange(9).reshape(3, 3)
>>> diags
tensor([[0, 1, 2],[3, 4, 5], [6, 7, 8])
>>> s = torch.sparse.spdiags(diags, torch.tensor([0, -1, -2]), (3, 3), layout=torch.sparse_csr)
>>> s
tensor(crow_indices=tensor([0, 1, 3, 6]),
       col_indices=tensor([0, 0, 1, 0, 1, 2]),
       values=tensor([0, 3, 1, 6, 4, 2]), size=(3, 3), nnz=6,
       layout=torch.sparse_csr)
>>> s.to_dense()
tensor([[0, 0, 0],
        [3, 1, 0],
        [6, 4, 2]])

设置大型输出的部分对角线

>>> diags = torch.tensor([[1, 2], [3, 4]])
>>> offsets = torch.tensor([0, -1])
>>> torch.sparse.spdiags(diags, offsets, (5, 5)).to_dense()
tensor([[1, 0, 0, 0, 0],
        [3, 2, 0, 0, 0],
        [0, 4, 0, 0, 0],
        [0, 0, 0, 0, 0],
        [0, 0, 0, 0, 0]])

注意

在沿给定对角线设置值时，对角线中的索引和 diagonals 的行中的索引被视为输出中的列索引。这会导致在设置具有正偏移量 k 的对角线时，该对角线上的第一个值将是 diagonals 的行的位置 k 中的值

指定正偏移量

>>> diags = torch.tensor([[1, 2, 3], [1, 2, 3], [1, 2, 3]])
>>> torch.sparse.spdiags(diags, torch.tensor([0, 1, 2]), (5, 5)).to_dense()
tensor([[1, 2, 3, 0, 0],
        [0, 2, 3, 0, 0],
        [0, 0, 3, 0, 0],
        [0, 0, 0, 0, 0],
        [0, 0, 0, 0, 0]])