papyri
This is a pre-release version (2.0.0.dev0+git20260907.41eeb59).Go to latest (1.18.0)
{ } Raw JSON

bundles / scipy 2.0.0.dev0+git20260907.41eeb59 / scipy / sparse / _extract / triu

function

scipy.sparse._extract:triu

source: build-install/usr/lib/python3.14/site-packages/scipy/sparse/_extract.py:149

Signature

def triu(A, k = 0, format = None)

Summary

Return the upper triangular portion of a sparse array or matrix.

Extended Summary

Returns the elements on or above the k-th diagonal of A.

  • k = 0 corresponds to the main diagonal

  • k > 0 is above the main diagonal

  • k < 0 is below the main diagonal

Parameters

A : dense or sparse array or matrix

Matrix whose upper trianglar portion is desired.

k : int : optional

The bottom-most diagonal of the upper triangle.

format : str

Sparse format of the result, e.g. format="csr", etc.

Returns

L : sparse array or matrix

Upper triangular portion of A in sparse format. Sparse array if A is a sparse array, otherwise matrix.

Examples

from scipy.sparse import csr_array, triu
A = csr_array([[1, 2, 0, 0, 3], [4, 5, 0, 6, 7], [0, 0, 8, 9, 0]],
               dtype='int32')
A.toarray()
triu(A).toarray()
triu(A).nnz
triu(A, k=1).toarray()
triu(A, k=-1).toarray()
✓
array([[1, 2, 0, 0, 3],
       [4, 5, 0, 6, 7],
       [0, 0, 8, 9, 0]], dtype=int32)

triu(A, format='csc')
✗
<Compressed Sparse Column sparse array of dtype 'int32'
	with 8 stored elements and shape (3, 5)>

See also

tril

lower triangle in sparse format

Aliases

  • scipy.sparse.triu

Referenced by

This package