SG++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
sgpp::optimization::FullSLE Class Reference

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

#include <FullSLE.hpp>

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

Public Member Functions

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

Protected Attributes

base::DataMatrixA
 coefficient matrix More...
 

Detailed Description

Full linear system, essentially a wrapper around base::DataMatrix.

Constructor & Destructor Documentation

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

Constructor.

Do not destruct the matrix A before this object!

Parameters
Acoefficient matrix

Referenced by clone().

sgpp::optimization::FullSLE::~FullSLE ( )
inlineoverride

Destructor.

Member Function Documentation

void sgpp::optimization::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::optimization::CloneableSLE.

References A, and FullSLE().

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

References A.

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

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

Returns
system dimension

Implements sgpp::optimization::SLE.

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

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

Implements sgpp::optimization::SLE.

References A.

bool sgpp::optimization::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::optimization::SLE.

References A.

Member Data Documentation

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

coefficient matrix

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


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