CSRMatrix

See also:: Format Specification or Source Specification for CSRMatrix.

class types.hdmf_common.CSRMatrix(varargin)[source]

Bases: types.hdmf_common.Container, types.untyped.GroupClass

CSRMATRIX - A compressed sparse row matrix. Data are stored in the standard CSR format, where 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]].

Required Properties*:: data, indices, indptr, shape

Constructor Summary

CSRMatrix(varargin)

CSRMATRIX - Constructor for CSRMatrix

Syntax:

cSRMatrix = types.hdmf_common.CSRMATRIX() creates a CSRMatrix object with unset property values.

cSRMatrix = types.hdmf_common.CSRMATRIX(Name, Value) creates a CSRMatrix object where one or more property values are specified using name-value pairs.

Input Arguments (Name-Value Arguments):

data (any) - The non-zero values in the matrix.
indices (uint) - The column indices.
indptr (uint) - The row index pointer.
shape (uint) - The shape (number of rows, number of columns) of this sparse matrix.

Output Arguments:

cSRMatrix (types.hdmf_common.CSRMatrix) - A CSRMatrix object

Property Summary

data: REQUIRED (any) The non-zero values in the matrix.

indices: REQUIRED (uint) The column indices.

indptr: REQUIRED (uint) The row index pointer.

shape: REQUIRED (uint) The shape (number of rows, number of columns) of this sparse matrix.

Tip

* If a required property link is not functional, the property may be defined in a superclass. Please refer to the superclass documentation.