Alien  1.3.0
Developer documentation
Loading...
Searching...
No Matches
Alien::MatrixElementT< Builder > Class Template Reference

Tool to manipulate a matrix entry while building the matrix. More...

#include <core/alien/data/utils/MatrixElement.h>

Collaboration diagram for Alien::MatrixElementT< Builder >:

Public Member Functions

 MatrixElementT (const Arccore::Integer iIndex, const Arccore::Integer jIndex, Builder &parent)
 Constructor.
Arccore::Real operator() () const
 accessor operator
void operator+= (Real value)
 Add and set operator.
void operator-= (Real value)
 Minus and set operator.
void operator= (Real value)
 Assignment operator.
template<typename Builder2>
bool operator= (const MatrixElementT< Builder2 > &other)
 Comparison operator.

Private Attributes

const Arccore::Integer m_iIndex
 The row index.
const Arccore::Integer m_jIndex
 The col index.
Builder & m_parent
 The builder.

Detailed Description

template<typename Builder>
class Alien::MatrixElementT< Builder >

Tool to manipulate a matrix entry while building the matrix.

Template Parameters
BuilderThe type of the builder used to build the matrix

Definition at line 44 of file MatrixElement.h.

Constructor & Destructor Documentation

◆ MatrixElementT()

template<typename Builder>
Alien::MatrixElementT< Builder >::MatrixElementT ( const Arccore::Integer iIndex,
const Arccore::Integer jIndex,
Builder & parent )
inline

Constructor.

Parameters
[in]iIndexThe row index of the entry
[in]jIndexThe col index of the entry
[in]parentThe builder used to build the matrix

Definition at line 53 of file MatrixElement.h.

Member Function Documentation

◆ operator()()

template<typename Builder>
Arccore::Real Alien::MatrixElementT< Builder >::operator() ( ) const
inline

accessor operator

Returns
value

Definition at line 64 of file MatrixElement.h.

◆ operator+=()

template<typename Builder>
void Alien::MatrixElementT< Builder >::operator+= ( Real value)
inline

Add and set operator.

Parameters
[in]valueThe value to add

Definition at line 70 of file MatrixElement.h.

◆ operator-=()

template<typename Builder>
void Alien::MatrixElementT< Builder >::operator-= ( Real value)
inline

Minus and set operator.

Parameters
[in]valueThe value to substract

Definition at line 79 of file MatrixElement.h.

◆ operator=() [1/2]

template<typename Builder>
template<typename Builder2>
bool Alien::MatrixElementT< Builder >::operator= ( const MatrixElementT< Builder2 > & other)
inline

Comparison operator.

Parameters
[in]otherTo be compare against.

Definition at line 98 of file MatrixElement.h.

◆ operator=() [2/2]

template<typename Builder>
void Alien::MatrixElementT< Builder >::operator= ( Real value)
inline

Assignment operator.

Parameters
[in]valueThe value to set

Definition at line 88 of file MatrixElement.h.

Member Data Documentation

◆ m_iIndex

template<typename Builder>
const Arccore::Integer Alien::MatrixElementT< Builder >::m_iIndex
private

The row index.

Definition at line 107 of file MatrixElement.h.

Referenced by Alien::MatrixElementT< DirectMatrixBuilder >::operator=().

◆ m_jIndex

template<typename Builder>
const Arccore::Integer Alien::MatrixElementT< Builder >::m_jIndex
private

The col index.

Definition at line 109 of file MatrixElement.h.

Referenced by Alien::MatrixElementT< DirectMatrixBuilder >::operator=().

◆ m_parent

template<typename Builder>
Builder& Alien::MatrixElementT< Builder >::m_parent
private

The builder.

Definition at line 111 of file MatrixElement.h.

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