NeoN::la::CSRMatrix< ValueType, IndexType > Class Template Reference

Sparse matrix class with compact storage by row (CSR) format. More...

#include <CSRMatrix.hpp>

Public Member Functions
	CSRMatrix (const Vector< ValueType > &values, const Vector< IndexType > &colIdxs, const Vector< IndexType > &rowOffs)
	Constructor for CSRMatrix.
	CSRMatrix (const Executor exec)
	~CSRMatrix ()=default
	Default destructor.
const Executor &	exec () const
	Get the executor associated with this matrix.
IndexType	nRows () const
	Get the number of rows in the matrix.
IndexType	nNonZeros () const
	Get the number of non-zero values in the matrix.
Vector< ValueType > &	values ()
	Get a reference to values vector.
Vector< IndexType > &	colIdxs ()
	Get a reference to column indices vector.
Vector< IndexType > &	rowOffs ()
	Get a reference to row offset vector.
const Vector< ValueType > &	values () const
	Get a const reference to values vector.
const Vector< IndexType > &	colIdxs () const
	Get a const reference to column indices vector.
const Vector< IndexType > &	rowOffs () const
	Get a const reference to row offset vector.
CSRMatrix< ValueType, IndexType >	copyToExecutor (Executor dstExec) const
	Copy the matrix to another executor.
CSRMatrix< ValueType, IndexType >	copyToHost () const
	Copy the matrix to the host.
CSRMatrixView< ValueType, IndexType >	view ()
	Get a view representation of the matrix's data.
const CSRMatrixView< const ValueType, const IndexType >	view () const
	Get a const view representation of the matrix's data.

Detailed Description

template<typename ValueType, typename IndexType>
class NeoN::la::CSRMatrix< ValueType, IndexType >

Sparse matrix class with compact storage by row (CSR) format.

Template Parameters

ValueType	The value type of the non-zero entries.
IndexType	The index type of the rows and columns.

Definition at line 85 of file CSRMatrix.hpp.

Constructor & Destructor Documentation

CSRMatrix() [1/2]

template<typename ValueType , typename IndexType >

NeoN::la::CSRMatrix< ValueType, IndexType >::CSRMatrix ( const Vector< ValueType > &  values, const Vector< IndexType > &  colIdxs, const Vector< IndexType > &  rowOffs  )

inline

Constructor for CSRMatrix.

Parameters

values	The non-zero values of the matrix.
colIdxs	The column indices for each non-zero value.
rowOffs	The starting index in values/colIdxs for each row.

Definition at line 96 of file CSRMatrix.hpp.

CSRMatrix() [2/2]

template<typename ValueType , typename IndexType >

NeoN::la::CSRMatrix< ValueType, IndexType >::CSRMatrix ( const Executor  exec )

inline

Definition at line 107 of file CSRMatrix.hpp.

~CSRMatrix()

template<typename ValueType , typename IndexType >

NeoN::la::CSRMatrix< ValueType, IndexType >::~CSRMatrix ( )

default

Default destructor.

Member Function Documentation

colIdxs() [1/2]

template<typename ValueType , typename IndexType >

Vector< IndexType > & NeoN::la::CSRMatrix< ValueType, IndexType >::colIdxs ( )

inline

Get a reference to column indices vector.

Returns

Vector containing the column indices.

Definition at line 146 of file CSRMatrix.hpp.

colIdxs() [2/2]

template<typename ValueType , typename IndexType >

const Vector< IndexType > & NeoN::la::CSRMatrix< ValueType, IndexType >::colIdxs ( ) const

inline

Get a const reference to column indices vector.

Returns

Const vector containing the column indices.

Definition at line 164 of file CSRMatrix.hpp.

copyToExecutor()

template<typename ValueType , typename IndexType >

CSRMatrix< ValueType, IndexType > NeoN::la::CSRMatrix< ValueType, IndexType >::copyToExecutor ( Executor  dstExec ) const

inline

Copy the matrix to another executor.

Parameters

dstExec

The destination executor.

Returns

A copy of the matrix on the destination executor.

Definition at line 177 of file CSRMatrix.hpp.

copyToHost()

template<typename ValueType , typename IndexType >

CSRMatrix< ValueType, IndexType > NeoN::la::CSRMatrix< ValueType, IndexType >::copyToHost ( ) const

inline

Copy the matrix to the host.

Returns

A copy of the matrix on the host.

Definition at line 193 of file CSRMatrix.hpp.

exec()

template<typename ValueType , typename IndexType >

const Executor & NeoN::la::CSRMatrix< ValueType, IndexType >::exec ( ) const

inline

Get the executor associated with this matrix.

Returns

Reference to the executor.

Definition at line 118 of file CSRMatrix.hpp.

nNonZeros()

template<typename ValueType , typename IndexType >

IndexType NeoN::la::CSRMatrix< ValueType, IndexType >::nNonZeros ( ) const

inline

Get the number of non-zero values in the matrix.

Returns

Number of non-zero values.

Definition at line 134 of file CSRMatrix.hpp.

nRows()

template<typename ValueType , typename IndexType >

IndexType NeoN::la::CSRMatrix< ValueType, IndexType >::nRows ( ) const

inline

Get the number of rows in the matrix.

Returns

Number of rows.

Definition at line 124 of file CSRMatrix.hpp.

rowOffs() [1/2]

template<typename ValueType , typename IndexType >

Vector< IndexType > & NeoN::la::CSRMatrix< ValueType, IndexType >::rowOffs ( )

inline

Get a reference to row offset vector.

Returns

Vi containing the row pointers.

Definition at line 152 of file CSRMatrix.hpp.

rowOffs() [2/2]

template<typename ValueType , typename IndexType >

const Vector< IndexType > & NeoN::la::CSRMatrix< ValueType, IndexType >::rowOffs ( ) const

inline

Get a const reference to row offset vector.

Returns

Const vector containing the row pointers.

Definition at line 170 of file CSRMatrix.hpp.

values() [1/2]

template<typename ValueType , typename IndexType >

Vector< ValueType > & NeoN::la::CSRMatrix< ValueType, IndexType >::values ( )

inline

Get a reference to values vector.

Returns

Vector containing the matrix values.

Definition at line 140 of file CSRMatrix.hpp.

values() [2/2]

template<typename ValueType , typename IndexType >

const Vector< ValueType > & NeoN::la::CSRMatrix< ValueType, IndexType >::values ( ) const

inline

Get a const reference to values vector.

Returns

Const vector containing the matrix values.

Definition at line 158 of file CSRMatrix.hpp.

view() [1/2]

template<typename ValueType , typename IndexType >

CSRMatrixView< ValueType, IndexType > NeoN::la::CSRMatrix< ValueType, IndexType >::view ( )

inline

Get a view representation of the matrix's data.

Returns

CSRMatrixView for easy access to matrix elements.

Definition at line 202 of file CSRMatrix.hpp.

view() [2/2]

template<typename ValueType , typename IndexType >

const CSRMatrixView< const ValueType, const IndexType > NeoN::la::CSRMatrix< ValueType, IndexType >::view ( ) const

inline

Get a const view representation of the matrix's data.

Returns

Const CSRMatrixView for read-only access to matrix elements.

Definition at line 211 of file CSRMatrix.hpp.

---

The documentation for this class was generated from the following file:

• /home/runner/work/NeoN/NeoN/include/NeoN/linearAlgebra/CSRMatrix.hpp