TNL::Matrices::SparseMatrixElement< Real, Index > Class Template Reference

Accessor for sparse matrix elements. More...

#include <TNL/Matrices/SparseMatrixElement.h>

Collaboration diagram for TNL::Matrices::SparseMatrixElement< Real, Index >:

Public Types
using	IndexType = Index
	Type of matrix elements column indexes.
using	RealType = Real
	Type of matrix elements values.

Public Member Functions
__cuda_callable__	SparseMatrixElement (RealType &value, IndexType rowIdx, IndexType &columnIdx, IndexType localIdx)
	Constructor.
__cuda_callable__ IndexType &	columnIndex ()
	Returns reference on matrix element column index.
__cuda_callable__ const IndexType &	columnIndex () const
	Returns constant reference on matrix element column index.
__cuda_callable__ const IndexType &	localIndex () const
	Returns constant reference on the rank of the non-zero matrix element in the row.
__cuda_callable__ const IndexType &	rowIndex () const
	Returns constant reference on matrix element column index.
__cuda_callable__ RealType &	value ()
	Returns reference on matrix element value.
__cuda_callable__ const RealType &	value () const
	Returns constant reference on matrix element value.

Static Public Member Functions
static constexpr bool	isBinary ()
	Test of binary matrix type.

Protected Attributes
IndexType &	columnIdx
IndexType	localIdx
IndexType	rowIdx
RealType &	value_

Detailed Description

template<typename Real, typename Index>
class TNL::Matrices::SparseMatrixElement< Real, Index >

Accessor for sparse matrix elements.

Template Parameters

Real	is a type of matrix elements values.
Index	is a type of matrix elements column indexes.

Constructor & Destructor Documentation

SparseMatrixElement()

template<typename Real , typename Index >

__cuda_callable__ TNL::Matrices::SparseMatrixElement< Real, Index >::SparseMatrixElement ( RealType & value, IndexType rowIdx, IndexType & columnIdx, IndexType localIdx )

inline

Constructor.

Parameters

value	is matrix element value.
rowIdx	is row index of the matrix element.
columnIdx	is a column index of the matrix element.
localIdx	is the rank of the non-zero elements in the matrix row.

Member Function Documentation

columnIndex() [1/2]

template<typename Real , typename Index >

__cuda_callable__ IndexType & TNL::Matrices::SparseMatrixElement< Real, Index >::columnIndex ( )

inlinenodiscard

Returns reference on matrix element column index.

Returns

reference on matrix element column index.

columnIndex() [2/2]

template<typename Real , typename Index >

__cuda_callable__ const IndexType & TNL::Matrices::SparseMatrixElement< Real, Index >::columnIndex ( ) const

inlinenodiscard

Returns constant reference on matrix element column index.

Returns

constant reference on matrix element column index.

isBinary()

template<typename Real , typename Index >

static constexpr bool TNL::Matrices::SparseMatrixElement< Real, Index >::isBinary ( )

inlinestaticnodiscardconstexpr

Test of binary matrix type.

Returns

true if the matrix is stored as binary and false otherwise.

localIndex()

template<typename Real , typename Index >

__cuda_callable__ const IndexType & TNL::Matrices::SparseMatrixElement< Real, Index >::localIndex ( ) const

inlinenodiscard

Returns constant reference on the rank of the non-zero matrix element in the row.

Returns

constant reference on the rank of the non-zero matrix element in the row.

rowIndex()

template<typename Real , typename Index >

__cuda_callable__ const IndexType & TNL::Matrices::SparseMatrixElement< Real, Index >::rowIndex ( ) const

inlinenodiscard

Returns constant reference on matrix element column index.

Returns

constant reference on matrix element column index.

value() [1/2]

template<typename Real , typename Index >

__cuda_callable__ RealType & TNL::Matrices::SparseMatrixElement< Real, Index >::value ( )

inlinenodiscard

Returns reference on matrix element value.

Returns

reference on matrix element value.

value() [2/2]

template<typename Real , typename Index >

__cuda_callable__ const RealType & TNL::Matrices::SparseMatrixElement< Real, Index >::value ( ) const

inlinenodiscard

Returns constant reference on matrix element value.

Returns

constant reference on matrix element value.

---

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

• src/TNL/Matrices/SparseMatrixElement.h