# scipy.sparse.csr_matrix¶

class scipy.sparse.csr_matrix(arg1, shape=None, dtype=None, copy=False)[source]

Compressed Sparse Row matrix

This can be instantiated in several ways:
csr_matrix(D)

with a dense matrix or rank-2 ndarray D

csr_matrix(S)

with another sparse matrix S (equivalent to S.tocsr())

csr_matrix((M, N), [dtype])

to construct an empty matrix with shape (M, N) dtype is optional, defaulting to dtype=’d’.

csr_matrix((data, (row_ind, col_ind)), [shape=(M, N)])

where data, row_ind and col_ind satisfy the relationship a[row_ind[k], col_ind[k]] = data[k].

csr_matrix((data, indices, indptr), [shape=(M, N)])

is the standard CSR representation where the column indices for row i are stored in indices[indptr[i]:indptr[i+1]] and their corresponding values are stored in data[indptr[i]:indptr[i+1]]. If the shape parameter is not supplied, the matrix dimensions are inferred from the index arrays.

Notes

Sparse matrices can be used in arithmetic operations: they support addition, subtraction, multiplication, division, and matrix power.

• efficient arithmetic operations CSR + CSR, CSR * CSR, etc.

• efficient row slicing

• fast matrix vector products

• slow column slicing operations (consider CSC)

• changes to the sparsity structure are expensive (consider LIL or DOK)

Examples

>>> import numpy as np
>>> from scipy.sparse import csr_matrix
>>> csr_matrix((3, 4), dtype=np.int8).toarray()
array([[0, 0, 0, 0],
[0, 0, 0, 0],
[0, 0, 0, 0]], dtype=int8)

>>> row = np.array([0, 0, 1, 2, 2, 2])
>>> col = np.array([0, 2, 2, 0, 1, 2])
>>> data = np.array([1, 2, 3, 4, 5, 6])
>>> csr_matrix((data, (row, col)), shape=(3, 3)).toarray()
array([[1, 0, 2],
[0, 0, 3],
[4, 5, 6]])

>>> indptr = np.array([0, 2, 3, 6])
>>> indices = np.array([0, 2, 2, 0, 1, 2])
>>> data = np.array([1, 2, 3, 4, 5, 6])
>>> csr_matrix((data, indices, indptr), shape=(3, 3)).toarray()
array([[1, 0, 2],
[0, 0, 3],
[4, 5, 6]])


Duplicate entries are summed together:

>>> row = np.array([0, 1, 2, 0])
>>> col = np.array([0, 1, 1, 0])
>>> data = np.array([1, 2, 4, 8])
>>> csr_matrix((data, (row, col)), shape=(3, 3)).toarray()
array([[9, 0, 0],
[0, 2, 0],
[0, 4, 0]])


As an example of how to construct a CSR matrix incrementally, the following snippet builds a term-document matrix from texts:

>>> docs = [["hello", "world", "hello"], ["goodbye", "cruel", "world"]]
>>> indptr = [0]
>>> indices = []
>>> data = []
>>> vocabulary = {}
>>> for d in docs:
...     for term in d:
...         index = vocabulary.setdefault(term, len(vocabulary))
...         indices.append(index)
...         data.append(1)
...     indptr.append(len(indices))
...
>>> csr_matrix((data, indices, indptr), dtype=int).toarray()
array([[2, 1, 0, 0],
[0, 1, 1, 1]])

Attributes
dtypedtype

Data type of the matrix

shape2-tuple

Get shape of a matrix.

ndimint

Number of dimensions (this is always 2)

nnz

Number of stored values, including explicit zeros.

data

CSR format data array of the matrix

indices

CSR format index array of the matrix

indptr

CSR format index pointer array of the matrix

has_sorted_indices

Determine whether the matrix has sorted indices

Methods

 __mul__(other) interpret other and call one of the following Element-wise arcsin. Element-wise arcsinh. Element-wise arctan. Element-wise arctanh. argmax([axis, out]) Return indices of maximum elements along an axis. argmin([axis, out]) Return indices of minimum elements along an axis. asformat(format[, copy]) Return this matrix in the passed format. Upcast matrix to a floating point format (if necessary) astype(dtype[, casting, copy]) Cast the matrix elements to a specified type. Element-wise ceil. check_format([full_check]) check whether the matrix format is valid conj([copy]) Element-wise complex conjugation. conjugate([copy]) Element-wise complex conjugation. Returns a copy of this matrix. Number of non-zero entries, equivalent to Element-wise deg2rad. diagonal([k]) Returns the kth diagonal of the matrix. dot(other) Ordinary dot product Remove zero entries from the matrix Element-wise expm1. Element-wise floor. Return the Hermitian transpose of this matrix. Get shape of a matrix. Returns a copy of column i of the matrix, as a (m x 1) CSR matrix (column vector). Format of a matrix representation as a string. Maximum number of elements to display when printed. getnnz([axis]) Number of stored values, including explicit zeros. Returns a copy of row i of the matrix, as a (1 x n) CSR matrix (row vector). Element-wise log1p. max([axis, out]) Return the maximum of the matrix or maximum along an axis. maximum(other) Element-wise maximum between this and another matrix. mean([axis, dtype, out]) Compute the arithmetic mean along the specified axis. min([axis, out]) Return the minimum of the matrix or maximum along an axis. minimum(other) Element-wise minimum between this and another matrix. multiply(other) Point-wise multiplication by another matrix, vector, or scalar. nonzero indices power(n[, dtype]) This function performs element-wise power. Remove empty space after all non-zero elements. Element-wise rad2deg. reshape(self, shape[, order, copy]) Gives a new shape to a sparse matrix without changing its data. resize(*shape) Resize the matrix in-place to dimensions given by shape Element-wise rint. set_shape(shape) setdiag(values[, k]) Set diagonal or off-diagonal elements of the array. Element-wise sign. Element-wise sin. Element-wise sinh. Sort the indices of this matrix in place Return a copy of this matrix with sorted indices Element-wise sqrt. sum([axis, dtype, out]) Sum the matrix elements over a given axis. Eliminate duplicate matrix entries by adding them together Element-wise tan. Element-wise tanh. toarray([order, out]) Return a dense ndarray representation of this matrix. tobsr([blocksize, copy]) Convert this matrix to Block Sparse Row format. tocoo([copy]) Convert this matrix to COOrdinate format. tocsc([copy]) Convert this matrix to Compressed Sparse Column format. tocsr([copy]) Convert this matrix to Compressed Sparse Row format. todense([order, out]) Return a dense matrix representation of this matrix. todia([copy]) Convert this matrix to sparse DIAgonal format. todok([copy]) Convert this matrix to Dictionary Of Keys format. tolil([copy]) Convert this matrix to List of Lists format. transpose([axes, copy]) Reverses the dimensions of the sparse matrix. Element-wise trunc.
 __getitem__

#### Previous topic

scipy.sparse.csc_matrix.trunc

#### Next topic

scipy.sparse.csr_matrix.__len__