torch.sparse.spdiags

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

通过将diagonals中的行值沿输出的指定对角线放置，来创建稀疏二维张量。

offsets 张量控制要设置的对角线。

• 如果 offsets[i] 等于 0，则表示它在主对角线上

• 如果 offsets[i] 小于 0，表示它位于主对角线下方

• 如果 offsets[i] 大于 0，表示它位于主对角线的上方

代码中diagonals的行数必须与offsets的长度相同，而且偏移量不能重复。

参数

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

• offsets (Tensor) – 需要设置的对角线元素，以向量的形式进行存储

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

关键字参数

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]])