SG++-Doxygen-Documentation
Loading...
Searching...
No Matches
sgpp::base::FullSLE Class Reference

Full linear system, essentially a wrapper around DataMatrix. More...

#include <FullSLE.hpp>

Inheritance diagram for sgpp::base::FullSLE:
sgpp::base::CloneableSLE sgpp::base::SLE

Public Member Functions

void clone (std::unique_ptr< CloneableSLE > &clone) const override
 Clones the linear system.
 
 FullSLE (DataMatrix &A)
 Constructor.
 
DataMatrixgetA ()
 
size_t getDimension () const override
 Pure virtual method returning the dimension (number of rows/columns) of the system.
 
double getMatrixEntry (size_t i, size_t j) override
 
bool isMatrixEntryNonZero (size_t i, size_t j) override
 
 ~FullSLE () override
 Destructor.
 
- Public Member Functions inherited from sgpp::base::CloneableSLE
 CloneableSLE ()
 Constructor.
 
bool isCloneable () const override
 
 ~CloneableSLE () override
 Destructor.
 
- Public Member Functions inherited from sgpp::base::SLE
virtual size_t countNNZ ()
 Count all non-zero entries.
 
virtual void matrixVectorMultiplication (const DataVector &x, DataVector &y)
 Multiply the matrix with a vector.
 
 SLE ()
 Constructor.
 
virtual ~SLE ()
 Destructor.
 

Protected Attributes

DataMatrixA
 coefficient matrix
 

Detailed Description

Full linear system, essentially a wrapper around DataMatrix.

Constructor & Destructor Documentation

◆ FullSLE()

sgpp::base::FullSLE::FullSLE ( DataMatrix A)
inlineexplicit

Constructor.

Do not destruct the matrix A before this object!

Parameters
Acoefficient matrix

◆ ~FullSLE()

sgpp::base::FullSLE::~FullSLE ( )
inlineoverride

Destructor.

Member Function Documentation

◆ clone()

void sgpp::base::FullSLE::clone ( std::unique_ptr< CloneableSLE > &  clone) const
inlineoverridevirtual

Clones the linear system.

Because A is stored as a reference, A is not copied (only b).

Parameters
[out]clonepointer to cloned object

Implements sgpp::base::CloneableSLE.

References A, and clone().

Referenced by clone().

◆ getA()

DataMatrix & sgpp::base::FullSLE::getA ( )
inline
Returns
coefficient matrix

References A.

◆ getDimension()

size_t sgpp::base::FullSLE::getDimension ( ) const
inlineoverridevirtual

Pure virtual method returning the dimension (number of rows/columns) of the system.

Returns
system dimension

Implements sgpp::base::SLE.

References A, and sgpp::base::DataMatrix::getNrows().

◆ getMatrixEntry()

double sgpp::base::FullSLE::getMatrixEntry ( size_t  i,
size_t  j 
)
inlineoverridevirtual
Parameters
irow index
jcolumn index
Returns
(i,j)-th entry of the matrix

Implements sgpp::base::SLE.

References A.

◆ isMatrixEntryNonZero()

bool sgpp::base::FullSLE::isMatrixEntryNonZero ( size_t  i,
size_t  j 
)
inlineoverridevirtual
Parameters
irow index
jcolumn index
Returns
whether the (i,j)-th entry of the matrix is non-zero

Implements sgpp::base::SLE.

References A.

Member Data Documentation

◆ A

DataMatrix& sgpp::base::FullSLE::A
protected

coefficient matrix

Referenced by clone(), getA(), getDimension(), getMatrixEntry(), and isMatrixEntryNonZero().


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