scipy.sparse.spmatrix.diagonal

spmatrix.diagonal(k=0)

Returns the k-th diagonal of the matrix.

Parameters:

k : int, optional

Which diagonal to set, corresponding to elements a[i, i+k]. Default: 0 (the main diagonal).

New in version 1.0.

See also

numpy.diagonal

Equivalent numpy function.

Examples

>>> from scipy.sparse import csr_matrix
>>> A = csr_matrix([[1, 2, 0], [0, 0, 3], [4, 0, 5]])
>>> A.diagonal()
array([1, 0, 5])
>>> A.diagonal(k=1)
array([2, 3])