triu_indices(row, col, offset=0, *, dtype=torch.long, device='cpu', layout=torch.strided) → Tensor¶
Returns the indices of the upper triangular part of a
colmatrix in a 2-by-N Tensor, where the first row contains row coordinates of all indices and the second row contains column coordinates. Indices are ordered based on rows and then columns.
The upper triangular part of the matrix is defined as the elements on and above the diagonal.
offsetcontrols which diagonal to consider. If
offset= 0, all elements on and above the main diagonal are retained. A positive value excludes just as many diagonals above the main diagonal, and similarly a negative value includes just as many diagonals below the main diagonal. The main diagonal are the set of indices for where are the dimensions of the matrix.
When running on CUDA,
row * colmust be less than to prevent overflow during calculation.
int) – number of rows in the 2-D matrix.
int) – number of columns in the 2-D matrix.
int) – diagonal offset from the main diagonal. Default: if not provided, 0.
- Keyword Arguments
torch.dtype, optional) – the desired data type of returned tensor. Default: if
torch.device, optional) – the desired device of returned tensor. Default: if
None, uses the current device for the default tensor type (see
devicewill be the CPU for CPU tensor types and the current CUDA device for CUDA tensor types.
torch.layout, optional) – currently only support
>>> a = torch.triu_indices(3, 3) >>> a tensor([[0, 0, 0, 1, 1, 2], [0, 1, 2, 1, 2, 2]])
>>> a = torch.triu_indices(4, 3, -1) >>> a tensor([[0, 0, 0, 1, 1, 1, 2, 2, 3], [0, 1, 2, 0, 1, 2, 1, 2, 2]])
>>> a = torch.triu_indices(4, 3, 1) >>> a tensor([[0, 0, 1], [1, 2, 2]])