diag_embed() in PyTorch

*Memos:

• My post explains diagonal().
• My post explains eye().
• My post explains diag() and diagflat().

diag_embed() can get the zero or more elements of a 2D or more D tensor on the diagonal and zero or more 0, 0., 0.+0.j or False elsewhere from a 1D or more D tensor as shown below:

*Memos:

• diag_embed() can be used with torch or a tensor.
• The 1st argument(tensor of int, float, complex or bool) with torch or using a tensor(tensor of int, float, complex or bool) is input(Required).
• The 2nd argument(int) with torch or the 1st argument(int) with a tensor is offset(Optional-Default:0).
• The 3rd argument(int) with torch or the 2nd argument(int) with a tensor is dim1(Optional-Default:-2).
• The 4th argument(int) with torch or the 3rd argument(int) with a tensor is dim2(Optional-Default:-1).

import torch

my_tensor = torch.tensor([7, -4, 5])

torch.diag_embed(input=my_tensor)
my_tensor.diag_embed()
torch.diag_embed(input=my_tensor, offset=0, dim1=0, dim2=1)
torch.diag_embed(input=my_tensor, offset=0, dim1=0, dim2=-1)
torch.diag_embed(input=my_tensor, offset=0, dim1=1, dim2=0)
torch.diag_embed(input=my_tensor, offset=0, dim1=1, dim2=-2)
torch.diag_embed(input=my_tensor, offset=0, dim1=-1, dim2=0)
torch.diag_embed(input=my_tensor, offset=0, dim1=-1, dim2=-2)
torch.diag_embed(input=my_tensor, offset=0, dim1=-2, dim2=1)
torch.diag_embed(input=my_tensor, offset=0, dim1=-2, dim2=-1)
# tensor([[7, 0, 0],
#         [0, -4, 0],
#         [0, 0, 5]])

torch.diag_embed(input=my_tensor, offset=1, dim1=0, dim2=1)
torch.diag_embed(input=my_tensor, offset=1, dim1=0, dim2=-1)
torch.diag_embed(input=my_tensor, offset=1, dim1=-2, dim2=1)
torch.diag_embed(input=my_tensor, offset=1, dim1=-2, dim2=-1)
torch.diag_embed(input=my_tensor, offset=-1, dim1=1, dim2=0)
torch.diag_embed(input=my_tensor, offset=-1, dim1=1, dim2=-2)
torch.diag_embed(input=my_tensor, offset=-1, dim1=-1, dim2=0)
torch.diag_embed(input=my_tensor, offset=-1, dim1=-1, dim2=-2)
# tensor([[0, 7, 0, 0],
#         [0, 0, -4, 0],
#         [0, 0, 0, 5],
#         [0, 0, 0, 0]])

torch.diag_embed(input=my_tensor, offset=1, dim1=1, dim2=0)
torch.diag_embed(input=my_tensor, offset=1, dim1=1, dim2=-2)
torch.diag_embed(input=my_tensor, offset=1, dim1=-1, dim2=0)
torch.diag_embed(input=my_tensor, offset=1, dim1=-1, dim2=-2)
torch.diag_embed(input=my_tensor, offset=-1, dim1=0, dim2=1)
torch.diag_embed(input=my_tensor, offset=-1, dim1=0, dim2=-1)
torch.diag_embed(input=my_tensor, offset=-1, dim1=-2, dim2=1)
torch.diag_embed(input=my_tensor, offset=-1, dim1=-2, dim2=-1)
# tensor([[0, 0, 0, 0],
#         [7, 0, 0, 0],
#         [0, -4, 0, 0],
#         [0, 0, 5, 0]])

torch.diag_embed(input=my_tensor, offset=2, dim1=0, dim2=1)
torch.diag_embed(input=my_tensor, offset=2, dim1=0, dim2=-1)
torch.diag_embed(input=my_tensor, offset=2, dim1=-2, dim2=1)
torch.diag_embed(input=my_tensor, offset=2, dim1=-2, dim2=-1)
torch.diag_embed(input=my_tensor, offset=-2, dim1=1, dim2=0)
torch.diag_embed(input=my_tensor, offset=-2, dim1=1, dim2=-2)
torch.diag_embed(input=my_tensor, offset=-2, dim1=-1, dim2=0)
torch.diag_embed(input=my_tensor, offset=-2, dim1=-1, dim2=-2)
# tensor([[0, 0, 7, 0, 0],
#         [0, 0, 0, -4, 0],
#         [0, 0, 0, 0, 5],
#         [0, 0, 0, 0, 0],
#         [0, 0, 0, 0, 0]])

torch.diag_embed(input=my_tensor, offset=2, dim1=1, dim2=0)
torch.diag_embed(input=my_tensor, offset=2, dim1=1, dim2=-2)
torch.diag_embed(input=my_tensor, offset=2, dim1=-1, dim2=0)
torch.diag_embed(input=my_tensor, offset=2, dim1=-1, dim2=-2)
torch.diag_embed(input=my_tensor, offset=-2, dim1=0, dim2=1)
torch.diag_embed(input=my_tensor, offset=-2, dim1=0, dim2=-1)
torch.diag_embed(input=my_tensor, offset=-2, dim1=-2, dim2=1)
torch.diag_embed(input=my_tensor, offset=-2, dim1=-2, dim2=-1)
# tensor([[0, 0, 0, 0, 0],
#         [0, 0, 0, 0, 0],
#         [7, 0, 0, 0, 0],
#         [0, -4, 0, 0, 0],
#         [0, 0, 5, 0, 0]])

my_tensor = torch.tensor([7., -4., 5.])

torch.diag_embed(input=my_tensor)
# tensor([[7., 0., 0.],
#         [0., -4., 0.],
#         [0., 0., 5.]])

my_tensor = torch.tensor([7+0j, -4+0j, 5+0j])

torch.diag_embed(input=my_tensor)
# tensor([[7.+0.j, 0.+0.j, 0.+0.j],
#         [0.+0.j, -4.+0.j, 0.+0.j],
#         [0.+0.j, 0.+0.j, 5.+0.j]])

my_tensor = torch.tensor([True, True, True])

torch.diag_embed(input=my_tensor)
# tensor([[True, False, False],
#         [False, True, False],
#         [False, False, True]])

my_tensor = torch.tensor([[7, -4, 5],
                          [-6, -3, 8],
                          [9, 1, -2]])
torch.diag_embed(input=my_tensor)
torch.diag_embed(input=my_tensor, offset=0, dim1=0, dim2=1)
torch.diag_embed(input=my_tensor, offset=0, dim1=0, dim2=-2)
torch.diag_embed(input=my_tensor, offset=0, dim1=1, dim2=0)
torch.diag_embed(input=my_tensor, offset=0, dim1=1, dim2=-3)
torch.diag_embed(input=my_tensor, offset=0, dim1=-2, dim2=0)
torch.diag_embed(input=my_tensor, offset=0, dim1=-2, dim2=-3)
torch.diag_embed(input=my_tensor, offset=0, dim1=-3, dim2=1)
torch.diag_embed(input=my_tensor, offset=0, dim1=-3, dim2=-2)
# tensor([[[7, -6, 9],
#          [0, 0, 0],
#          [0, 0, 0]],
#         [[0, 0, 0],
#          [-4, -3, 1],
#          [0, 0, 0]],
#         [[0, 0, 0],
#          [0, 0, 0],
#          [5, 8, -2]]])

torch.diag_embed(input=my_tensor, offset=0, dim1=0, dim2=2)
torch.diag_embed(input=my_tensor, offset=0, dim1=0, dim2=-1)
torch.diag_embed(input=my_tensor, offset=0, dim1=2, dim2=0)
torch.diag_embed(input=my_tensor, offset=0, dim1=2, dim2=-3)
torch.diag_embed(input=my_tensor, offset=0, dim1=-1, dim2=0)
torch.diag_embed(input=my_tensor, offset=0, dim1=-1, dim2=-3)
torch.diag_embed(input=my_tensor, offset=0, dim1=-3, dim2=2)
torch.diag_embed(input=my_tensor, offset=0, dim1=-3, dim2=-1)
# tensor([[[7, 0, 0],
#          [-6, 0, 0],
#          [9, 0, 0]],
#         [[0, -4, 0],
#          [0, -3, 0],
#          [0, 1, 0]],
#         [[0, 0, 5],
#          [0, 0, 8],
#          [0, 0, -2]]])

torch.diag_embed(input=my_tensor, offset=0, dim1=1, dim2=2)
torch.diag_embed(input=my_tensor, offset=0, dim1=1, dim2=-1)
torch.diag_embed(input=my_tensor, offset=0, dim1=2, dim2=1)
torch.diag_embed(input=my_tensor, offset=0, dim1=2, dim2=-2)
torch.diag_embed(input=my_tensor, offset=0, dim1=-1, dim2=1)
torch.diag_embed(input=my_tensor, offset=0, dim1=-1, dim2=-2)
torch.diag_embed(input=my_tensor, offset=0, dim1=-2, dim2=2)
torch.diag_embed(input=my_tensor, offset=0, dim1=-2, dim2=-1)
# tensor([[[7, 0, 0],
#          [0, -4, 0],
#          [0, 0, 5]],
#         [[-6, 0, 0],
#          [0, -3, 0],
#          [0, 0, 8]],
#         [[9, 0, 0],
#          [0, 1, 0],
#          [0, 0, -2]]])

torch.diag_embed(input=my_tensor, offset=1, dim1=0, dim2=1)
torch.diag_embed(input=my_tensor, offset=1, dim1=0, dim2=-2)
torch.diag_embed(input=my_tensor, offset=1, dim1=-3, dim2=1)
torch.diag_embed(input=my_tensor, offset=1, dim1=-3, dim2=-2)
torch.diag_embed(input=my_tensor, offset=-1, dim1=1, dim2=0)
torch.diag_embed(input=my_tensor, offset=-1, dim1=1, dim2=-3)
torch.diag_embed(input=my_tensor, offset=-1, dim1=-2, dim2=0)
torch.diag_embed(input=my_tensor, offset=-1, dim1=-2, dim2=-3)
# tensor([[[0, 0, 0],
#          [7, -6, 9],
#          [0, 0, 0],
#          [0, 0, 0]],
#         [[0, 0, 0],
#          [0, 0, 0],
#          [-4, -3, 1],
#          [0, 0, 0]],
#         [[0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0],
#          [5, 8, -2]],
#         [[0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0]]])

torch.diag_embed(input=my_tensor, offset=1, dim1=0, dim2=2)
torch.diag_embed(input=my_tensor, offset=1, dim1=0, dim2=-1)
torch.diag_embed(input=my_tensor, offset=1, dim1=-3, dim2=2)
torch.diag_embed(input=my_tensor, offset=1, dim1=-3, dim2=-1)
torch.diag_embed(input=my_tensor, offset=-1, dim1=2, dim2=0)
torch.diag_embed(input=my_tensor, offset=-1, dim1=2, dim2=-3)
torch.diag_embed(input=my_tensor, offset=-1, dim1=-1, dim2=0)
torch.diag_embed(input=my_tensor, offset=-1, dim1=-1, dim2=-3)
# tensor([[[0, 7, 0, 0],
#          [0, -6, 0, 0],
#          [0, 9, 0, 0]],
#         [[0, 0, -4, 0],
#          [0, 0, -3, 0],
#          [0, 0, 1, 0]],
#         [[0, 0, 0, 5],
#          [0, 0, 0, 8],
#          [0, 0, 0, -2]],
#         [[0, 0, 0, 0],
#          [0, 0, 0, 0],
#          [0, 0, 0, 0]]])

torch.diag_embed(input=my_tensor, offset=1, dim1=1, dim2=0)
torch.diag_embed(input=my_tensor, offset=1, dim1=1, dim2=-3)
torch.diag_embed(input=my_tensor, offset=1, dim1=-2, dim2=0)
torch.diag_embed(input=my_tensor, offset=1, dim1=-2, dim2=-3)
torch.diag_embed(input=my_tensor, offset=-1, dim1=0, dim2=1)
torch.diag_embed(input=my_tensor, offset=-1, dim1=0, dim2=-2)
torch.diag_embed(input=my_tensor, offset=-1, dim1=-3, dim2=1)
torch.diag_embed(input=my_tensor, offset=-1, dim1=-3, dim2=-2)
# tensor([[[0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0]],
#         [[7, -6, 9],
#          [0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0]],
#         [[0, 0, 0],
#          [-4, -3, 1],
#          [0, 0, 0],
#          [0, 0, 0]],
#         [[0, 0, 0],
#          [0, 0, 0],
#          [5, 8, -2],
#          [0, 0, 0]]])

torch.diag_embed(input=my_tensor, offset=1, dim1=1, dim2=2)
torch.diag_embed(input=my_tensor, offset=1, dim1=1, dim2=-1)
torch.diag_embed(input=my_tensor, offset=1, dim1=-2, dim2=2)
torch.diag_embed(input=my_tensor, offset=1, dim1=-2, dim2=-1)
torch.diag_embed(input=my_tensor, offset=-1, dim1=2, dim2=1)
torch.diag_embed(input=my_tensor, offset=-1, dim1=2, dim2=-2)
torch.diag_embed(input=my_tensor, offset=-1, dim1=-1, dim2=1)
torch.diag_embed(input=my_tensor, offset=-1, dim1=-1, dim2=-2)
# tensor([[[0, 7, 0, 0],
#          [0, 0, -4, 0],
#          [0, 0, 0, 5],
#          [0, 0, 0, 0]],
#         [[0, -6, 0, 0],
#          [0, 0, -3, 0],
#          [0, 0, 0, 8],
#          [0, 0, 0, 0]],
#         [[0, 9, 0, 0],
#          [0, 0, 1, 0],
#          [0, 0, 0, -2],
#          [0, 0, 0, 0]]])

torch.diag_embed(input=my_tensor, offset=1, dim1=2, dim2=0)
torch.diag_embed(input=my_tensor, offset=1, dim1=2, dim2=-3)
torch.diag_embed(input=my_tensor, offset=1, dim1=-1, dim2=0)
torch.diag_embed(input=my_tensor, offset=1, dim1=-1, dim2=-3)
torch.diag_embed(input=my_tensor, offset=-1, dim1=0, dim2=2)
torch.diag_embed(input=my_tensor, offset=-1, dim1=0, dim2=-1)
torch.diag_embed(input=my_tensor, offset=-1, dim1=-3, dim2=2)
torch.diag_embed(input=my_tensor, offset=-1, dim1=-3, dim2=-1)
# tensor([[[0, 0, 0, 0],
#          [0, 0, 0, 0],
#          [0, 0, 0, 0]],
#         [[7, 0, 0, 0],
#          [-6, 0, 0, 0],
#          [9, 0, 0, 0]],
#         [[0, -4, 0, 0],
#          [0, -3, 0, 0],
#          [0, 1, 0, 0]],
#         [[0, 0, 5, 0],
#          [0, 0, 8, 0],
#          [0, 0, -2, 0]]])

torch.diag_embed(input=my_tensor, offset=1, dim1=2, dim2=1)
torch.diag_embed(input=my_tensor, offset=1, dim1=2, dim2=-2)
torch.diag_embed(input=my_tensor, offset=1, dim1=-1, dim2=1)
torch.diag_embed(input=my_tensor, offset=1, dim1=-1, dim2=-2)
torch.diag_embed(input=my_tensor, offset=-1, dim1=1, dim2=2)
torch.diag_embed(input=my_tensor, offset=-1, dim1=1, dim2=-1)
torch.diag_embed(input=my_tensor, offset=-1, dim1=-2, dim2=2)
torch.diag_embed(input=my_tensor, offset=-1, dim1=-2, dim2=-1)
# tensor([[[0, 0, 0, 0],
#          [7, 0, 0, 0],
#          [0, -4, 0, 0],
#          [0, 0, 5, 0]],
#         [[0, 0, 0, 0],
#          [-6, 0, 0, 0],
#          [0, -3, 0, 0],
#          [0, 0, 8, 0]],
#         [[0, 0, 0, 0],
#          [9, 0, 0, 0],
#          [0, 1, 0, 0],
#          [0, 0, -2, 0]]])

torch.diag_embed(input=my_tensor, offset=2, dim1=0, dim2=1)
torch.diag_embed(input=my_tensor, offset=2, dim1=0, dim2=-2)
torch.diag_embed(input=my_tensor, offset=2, dim1=-3, dim2=1)
torch.diag_embed(input=my_tensor, offset=2, dim1=-3, dim2=-2)
torch.diag_embed(input=my_tensor, offset=-2, dim1=1, dim2=0)
torch.diag_embed(input=my_tensor, offset=-2, dim1=1, dim2=-3)
torch.diag_embed(input=my_tensor, offset=-2, dim1=-2, dim2=0)
torch.diag_embed(input=my_tensor, offset=-2, dim1=-2, dim2=-3)
# tensor([[[0, 0, 0],
#          [0, 0, 0],
#          [7, -6, 9],
#          [0, 0, 0],
#          [0, 0, 0]],
#         [[0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0],
#          [-4, -3, 1],
#          [0, 0, 0]],
#         [[0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0],
#          [5, 8, -2]],
#         [[0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0]],
#         [[0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0]]])

torch.diag_embed(input=my_tensor, offset=2, dim1=0, dim2=2)
torch.diag_embed(input=my_tensor, offset=2, dim1=0, dim2=-1)
torch.diag_embed(input=my_tensor, offset=2, dim1=-3, dim2=2)
torch.diag_embed(input=my_tensor, offset=2, dim1=-3, dim2=-1)
torch.diag_embed(input=my_tensor, offset=-2, dim1=2, dim2=0)
torch.diag_embed(input=my_tensor, offset=-2, dim1=2, dim2=-3)
torch.diag_embed(input=my_tensor, offset=-2, dim1=-1, dim2=0)
torch.diag_embed(input=my_tensor, offset=-2, dim1=-1, dim2=-3)
# tensor([[[0, 0, 7, 0, 0],
#          [0, 0, -6, 0, 0],
#          [0, 0, 9, 0, 0]],
#         [[0, 0, 0, -4, 0],
#          [0, 0, 0, -3, 0],
#          [0, 0, 0, 1, 0]],
#         [[0, 0, 0, 0, 5],
#          [0, 0, 0, 0, 8],
#          [0, 0, 0, 0, -2]],
#         [[0, 0, 0, 0, 0],
#          [0, 0, 0, 0, 0],
#          [0, 0, 0, 0, 0]],
#         [[0, 0, 0, 0, 0],
#          [0, 0, 0, 0, 0],
#          [0, 0, 0, 0, 0]]])

torch.diag_embed(input=my_tensor, offset=2, dim1=1, dim2=0)
torch.diag_embed(input=my_tensor, offset=2, dim1=1, dim2=-3)
torch.diag_embed(input=my_tensor, offset=2, dim1=-2, dim2=0)
torch.diag_embed(input=my_tensor, offset=2, dim1=-2, dim2=-3)
torch.diag_embed(input=my_tensor, offset=-2, dim1=0, dim2=1)
torch.diag_embed(input=my_tensor, offset=-2, dim1=0, dim2=-2)
torch.diag_embed(input=my_tensor, offset=-2, dim1=-3, dim2=1)
torch.diag_embed(input=my_tensor, offset=-2, dim1=-3, dim2=-2)
# tensor([[[0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0]],
#         [[0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0]],
#         [[7, -6, 9],
#          [0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0]],
#         [[0, 0, 0],
#          [-4, -3, 1],
#          [0, 0, 0],
#          [0, 0, 0],
#          [0, 0, 0]],
#         [[0, 0, 0],
#          [0, 0, 0],
#          [5, 8, -2],
#          [0, 0, 0],
#          [0, 0, 0]]])

torch.diag_embed(input=my_tensor, offset=2, dim1=1, dim2=2)
torch.diag_embed(input=my_tensor, offset=2, dim1=1, dim2=-1)
torch.diag_embed(input=my_tensor, offset=2, dim1=-2, dim2=2)
torch.diag_embed(input=my_tensor, offset=2, dim1=-2, dim2=-1)
torch.diag_embed(input=my_tensor, offset=-2, dim1=2, dim2=1)
torch.diag_embed(input=my_tensor, offset=-2, dim1=2, dim2=-2)
torch.diag_embed(input=my_tensor, offset=-2, dim1=-1, dim2=1)
torch.diag_embed(input=my_tensor, offset=-2, dim1=-1, dim2=-2)
# tensor([[[0, 0, 7, 0, 0],
#          [0, 0, 0, -4, 0],
#          [0, 0, 0, 0, 5],
#          [0, 0, 0, 0, 0],
#          [0, 0, 0, 0, 0]],
#         [[0, 0, -6, 0, 0],
#          [0, 0, 0,-3, 0],
#          [0, 0, 0, 0, 8],
#          [0, 0, 0, 0, 0],
#          [0, 0, 0, 0, 0]],
#         [[0, 0, 9, 0, 0],
#          [0, 0, 0, 1, 0],
#          [0, 0, 0, 0, -2],
#          [0, 0, 0, 0, 0],
#          [0, 0, 0, 0, 0]]])

torch.diag_embed(input=my_tensor, offset=2, dim1=2, dim2=0)
torch.diag_embed(input=my_tensor, offset=2, dim1=2, dim2=-3)
torch.diag_embed(input=my_tensor, offset=2, dim1=-1, dim2=0)
torch.diag_embed(input=my_tensor, offset=2, dim1=-1, dim2=-3)
torch.diag_embed(input=my_tensor, offset=-2, dim1=0, dim2=2)
torch.diag_embed(input=my_tensor, offset=-2, dim1=0, dim2=-1)
torch.diag_embed(input=my_tensor, offset=-2, dim1=-3, dim2=2)
torch.diag_embed(input=my_tensor, offset=-2, dim1=-3, dim2=-1)
# tensor([[[0, 0, 0, 0, 0],
#          [0, 0, 0, 0, 0],
#          [0, 0, 0, 0, 0]],
#         [[0, 0, 0, 0, 0],
#          [0, 0, 0, 0, 0],
#          [0, 0, 0, 0, 0]],
#         [[7, 0, 0, 0, 0],
#          [-6, 0, 0, 0, 0],
#          [9, 0, 0, 0, 0]],
#         [[0, -4, 0, 0, 0],
#          [0, -3, 0, 0, 0],
#          [0, 1, 0, 0, 0]],
#         [[0, 0, 5, 0, 0],
#          [0, 0, 8, 0, 0],
#          [0, 0, -2, 0, 0]]])

torch.diag_embed(input=my_tensor, offset=2, dim1=2, dim2=1)
torch.diag_embed(input=my_tensor, offset=2, dim1=2, dim2=-2)
torch.diag_embed(input=my_tensor, offset=2, dim1=-1, dim2=1)
torch.diag_embed(input=my_tensor, offset=2, dim1=-1, dim2=-2)
torch.diag_embed(input=my_tensor, offset=-2, dim1=1, dim2=2)
torch.diag_embed(input=my_tensor, offset=-2, dim1=1, dim2=-1)
torch.diag_embed(input=my_tensor, offset=-2, dim1=-2, dim2=2)
torch.diag_embed(input=my_tensor, offset=-2, dim1=-2, dim2=-1)
# tensor([[[0, 0, 0, 0, 0],
#          [0, 0, 0, 0, 0],
#          [7, 0, 0, 0, 0],
#          [0, -4, 0, 0, 0],
#          [0, 0, 5, 0, 0]],
#         [[0, 0, 0, 0, 0],
#          [0, 0, 0, 0, 0],
#          [-6, 0, 0, 0, 0],
#          [0, -3, 0, 0, 0],
#          [0, 0, 8, 0, 0]],
#         [[0, 0, 0, 0, 0],
#          [0, 0, 0, 0, 0],
#          [9, 0, 0, 0, 0],
#          [0, 1, 0, 0, 0],
#          [0, 0, -2, 0, 0]]])