Template Numerical Library version\ main:f17d0c8
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Attributes | List of all members
TNL::Matrices::MultidiagonalMatrixElement< Real, Index > Class Template Reference

Accessor for multidiagonal matrix elements. More...

#include <TNL/Matrices/MultidiagonalMatrixElement.h>

Collaboration diagram for TNL::Matrices::MultidiagonalMatrixElement< Real, Index >:
Collaboration graph
[legend]

Public Types

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

Public Member Functions

__cuda_callable__ MultidiagonalMatrixElement (RealType &value, IndexType rowIdx, IndexType columnIdx, IndexType localIdx)
 Constructor.
 
__cuda_callable__ const IndexTypecolumnIndex () const
 Returns constant reference on matrix element column index.
 
__cuda_callable__ const IndexTypelocalIndex () const
 Returns constant reference on the rank of the non-zero matrix element in the row.
 
__cuda_callable__ const IndexTyperowIndex () const
 Returns constant reference on matrix element column index.
 
__cuda_callable__ RealTypevalue ()
 Returns reference on matrix element value.
 
__cuda_callable__ const RealTypevalue () const
 Returns constant reference on matrix element value.
 

Protected Attributes

IndexType columnIdx
 
IndexType localIdx
 
IndexType rowIdx
 
RealTypevalue_
 

Detailed Description

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

Accessor for multidiagonal matrix elements.

Template Parameters
Realis a type of matrix elements values.
Indexis a type of matrix elements column indexes.

Constructor & Destructor Documentation

◆ MultidiagonalMatrixElement()

template<typename Real , typename Index >
__cuda_callable__ TNL::Matrices::MultidiagonalMatrixElement< Real, Index >::MultidiagonalMatrixElement ( RealType & value,
IndexType rowIdx,
IndexType columnIdx,
IndexType localIdx )
inline

Constructor.

Parameters
valueis matrix element value.
rowIdxis row index of the matrix element.
columnIdxis a column index of the matrix element.
localIdxis the rank of the non-zero elements in the matrix row.

Member Function Documentation

◆ columnIndex()

template<typename Real , typename Index >
__cuda_callable__ const IndexType & TNL::Matrices::MultidiagonalMatrixElement< Real, Index >::columnIndex ( ) const
inline

Returns constant reference on matrix element column index.

Returns
constant reference on matrix element column index.

◆ localIndex()

template<typename Real , typename Index >
__cuda_callable__ const IndexType & TNL::Matrices::MultidiagonalMatrixElement< Real, Index >::localIndex ( ) const
inline

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::MultidiagonalMatrixElement< Real, Index >::rowIndex ( ) const
inline

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::MultidiagonalMatrixElement< Real, Index >::value ( )
inline

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::MultidiagonalMatrixElement< Real, Index >::value ( ) const
inline

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: