Rate this Page
★★★★★

torch.diagonal_scatter#

torch.diagonal_scatter(input,src,offset=0,dim1=0,dim2=1)→Tensor#

Embeds the values of thesrc tensor intoinput alongthe diagonal elements ofinput, with respect todim1anddim2.

This function returns a tensor with fresh storage; it does notreturn a view.

The argumentoffset controls which diagonal to consider:

  • Ifoffset = 0, it is the main diagonal.

  • Ifoffset > 0, it is above the main diagonal.

  • Ifoffset < 0, it is below the main diagonal.

Parameters

  • input (Tensor) – the input tensor. Must be at least 2-dimensional.

  • src (Tensor) – the tensor to embed intoinput.

  • offset (int,optional) – which diagonal to consider. Default: 0(main diagonal).

  • dim1 (int,optional) – first dimension with respect to which totake diagonal. Default: 0.

  • dim2 (int,optional) – second dimension with respect to which totake diagonal. Default: 1.

Note

src must be of the proper size in order to be embeddedintoinput. Specifically, it should have the same shape astorch.diagonal(input,offset,dim1,dim2)

Examples:

>>>a=torch.zeros(3,3)>>>atensor([[0., 0., 0.],        [0., 0., 0.],        [0., 0., 0.]])>>>torch.diagonal_scatter(a,torch.ones(3),0)tensor([[1., 0., 0.],        [0., 1., 0.],        [0., 0., 1.]])>>>torch.diagonal_scatter(a,torch.ones(2),1)tensor([[0., 1., 0.],        [0., 0., 1.],        [0., 0., 0.]])