sgpp::optimization::SLE Class Reference

Abstract class representing a system of linear equations. More...

#include <SLE.hpp>

Inheritance diagram for sgpp::optimization::SLE:

Public Member Functions
virtual size_t	countNNZ ()
	Count all non-zero entries. More...
virtual size_t	getDimension () const =0
	Pure virtual method returning the dimension (number of rows/columns) of the system. More...
virtual double	getMatrixEntry (size_t i, size_t j)=0
	Pure virtual method for retrieving a matrix entry. More...
virtual bool	isCloneable () const
virtual bool	isMatrixEntryNonZero (size_t i, size_t j)=0
	Pure virtual method for checking if a matrix entry vanishes or not. 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...

Detailed Description

Abstract class representing a system of linear equations.

All row and column indices are zero based.

Constructor & Destructor Documentation

SLE()

sgpp::optimization::SLE::SLE ( )

inline

Constructor.

~SLE()

virtual sgpp::optimization::SLE::~SLE ( )

inlinevirtual

Destructor.

References getMatrixEntry(), python.statsfileInfo::i, isMatrixEntryNonZero(), and python.utils.statsfile2gnuplot::j.

Member Function Documentation

countNNZ()

virtual size_t sgpp::optimization::SLE::countNNZ ( )

inlinevirtual

Count all non-zero entries.

Standard implementation with \(\mathcal{O}(n^2)\) checks.

Returns

number of non-zero entries

References getDimension(), and isMatrixEntryNonZero().

getDimension()

virtual size_t sgpp::optimization::SLE::getDimension ( ) const

pure virtual

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

Returns

system dimension

Implemented in sgpp::optimization::HierarchisationSLE, and sgpp::optimization::FullSLE.

Referenced by countNNZ(), matrixVectorMultiplication(), sgpp::optimization::Printer::printSLE(), sgpp::optimization::sle_solver::Gmmpp::solve(), sgpp::optimization::sle_solver::Armadillo::solve(), sgpp::optimization::sle_solver::Eigen::solve(), sgpp::optimization::sle_solver::UMFPACK::solve(), sgpp::optimization::sle_solver::Auto::solve(), and sgpp::optimization::sle_solver::SLESolver::solve().

getMatrixEntry()

virtual double sgpp::optimization::SLE::getMatrixEntry ( size_t  i, size_t  j  )

pure virtual

Pure virtual method for retrieving a matrix entry.

Parameters

i	row index
j	column index

Returns

(i,j)-th entry of the matrix

Implemented in sgpp::optimization::HierarchisationSLE, and sgpp::optimization::FullSLE.

Referenced by matrixVectorMultiplication(), sgpp::optimization::Printer::printSLE(), sgpp::optimization::sle_solver::Gmmpp::solve(), sgpp::optimization::sle_solver::GaussianElimination::solve(), sgpp::optimization::sle_solver::Armadillo::solve(), sgpp::optimization::sle_solver::Eigen::solve(), sgpp::optimization::sle_solver::UMFPACK::solve(), sgpp::optimization::sle_solver::BiCGStab::solve(), and ~SLE().

isCloneable()

virtual bool sgpp::optimization::SLE::isCloneable ( ) const

inlinevirtual

Returns

whether this system derives from CloneableSLE or not (standard: false)

Reimplemented in sgpp::optimization::CloneableSLE.

Referenced by sgpp::optimization::sle_solver::Gmmpp::solve(), sgpp::optimization::sle_solver::Eigen::solve(), sgpp::optimization::sle_solver::Armadillo::solve(), and sgpp::optimization::sle_solver::UMFPACK::solve().

isMatrixEntryNonZero()

virtual bool sgpp::optimization::SLE::isMatrixEntryNonZero ( size_t  i, size_t  j  )

pure virtual

Pure virtual method for checking if a matrix entry vanishes or not.

Parameters

i	row index
j	column index

Returns

whether the (i,j)-th entry of the matrix is non-zero

Implemented in sgpp::optimization::HierarchisationSLE, and sgpp::optimization::FullSLE.

Referenced by countNNZ(), sgpp::optimization::sle_solver::Auto::solve(), and ~SLE().

matrixVectorMultiplication()

virtual void sgpp::optimization::SLE::matrixVectorMultiplication ( const base::DataVector &  x, base::DataVector &  y  )

inlinevirtual

Multiply the matrix with a vector.

Standard implementation with \(\mathcal{O}(n^2)\) scalar multiplications.

Parameters

	x	vector to be multiplied
[out]	y	\(y = Ax\)

References getDimension(), getMatrixEntry(), python.statsfileInfo::i, python.utils.statsfile2gnuplot::j, and sgpp::base::DataVector::setAll().

Referenced by sgpp::optimization::sle_solver::BiCGStab::solve().

---

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

• optimization/src/sgpp/optimization/sle/system/SLE.hpp