numpy.tril_indices() function

Introduction

What is numpy.tril_indices()?

Syntax

numpy.tril_indices(n, k=0, m=None)

• n : int - The row dimension of the arrays for which the returned indices will be valid.
• k : int, optional - Diagonal offset. The default is 0, which includes the main diagonal.
• m : int, optional - The column dimension of the arrays for which the returned arrays will be valid. By default, m is taken equal to n.

Return Value

Example Usage

import numpy as np

# Create indices for a 3x3 lower triangular matrix (including the main diagonal)
row_indices, col_indices = np.tril_indices(3)
print("Row Indices:", row_indices)
print("Column Indices:", col_indices)

# Create indices for a 3x3 lower triangular matrix (excluding the main diagonal)
row_indices, col_indices = np.tril_indices(3, k=1)
print("Row Indices:", row_indices)
print("Column Indices:", col_indices)

Row Indices: [0 1 1 2 2 2]
Column Indices: [0 0 1 0 1 2]

Row Indices: [0 0 0 1 1 1 2 2 2]
Column Indices: [0 1 2 0 1 2 0 1 2]

Applications

• Sparse Matrix Representation: It can be used to generate indices for the lower triangular part of a matrix, which is useful in sparse matrix representations.
• Efficient Matrix Operations: When performing operations that involve the lower triangular elements, such as solving linear systems, these indices can be used to access and manipulate the specified elements more effectively.
• Masking Upper Triangular Elements: You can use the generated indices to mask or zero out the upper triangular elements of a matrix, which may be useful in various mathematical operations.
• Data Filtering: In data analysis, you can filter data points above the main diagonal of a correlation matrix, for example, to focus on meaningful correlations.

Conclusion