sgpp::solver::SLESolverSP Class Reference

#include <SLESolverSP.hpp>

Inheritance diagram for sgpp::solver::SLESolverSP:

Public Member Functions
	SLESolverSP (size_t imax, float epsilon)
	Std-Constructor. More...
virtual void	solve (sgpp::base::OperationMatrixSP &SystemMatrix, sgpp::base::DataVectorSP &alpha, sgpp::base::DataVectorSP &b, bool reuse=false, bool verbose=false, float max_threshold=DEFAULT_RES_THRESHOLD)=0
	Pure virtual Function that defines a solve method for an iterative solver. More...
virtual	~SLESolverSP ()
	Std-Destructor. More...
Public Member Functions inherited from sgpp::solver::SGSolverSP
float	getEpsilon ()
	gets the the epsilon, that is used in the SGSolver More...
size_t	getNumberIterations ()
	function that returns the number of needed solve steps More...
float	getResiduum ()
	function the returns the residuum (current or final), error of the solver More...
void	setEpsilon (float eps)
	resets the epsilon, that is used in the SGSolver More...
void	setMaxIterations (size_t nIterations)
	resets the number of maximum iterations More...
	SGSolverSP (size_t nMaximumIterations, float epsilon)
	Std-Constructor. More...
virtual	~SGSolverSP ()
	Std-Destructor. More...

Additional Inherited Members
Protected Attributes inherited from sgpp::solver::SGSolverSP
float	myEpsilon
	epsilon needed in the, e.g. final error in the iterative solver, or a timestep More...
size_t	nIterations
	Number of Iterations needed for the solve. More...
size_t	nMaxIterations
	Number of maximum iterations for cg. More...
float	residuum
	residuum More...

Constructor & Destructor Documentation

SLESolverSP()

sgpp::solver::SLESolverSP::SLESolverSP ( size_t  imax, float  epsilon  )

inline

Std-Constructor.

Parameters

imax	number of maximum executed iterations
epsilon	the final error in the iterative solver

~SLESolverSP()

virtual sgpp::solver::SLESolverSP::~SLESolverSP ( )

inlinevirtual

Std-Destructor.

References alpha, chess::b, DEFAULT_RES_THRESHOLD, and solve().

Member Function Documentation

solve()

virtual void sgpp::solver::SLESolverSP::solve ( sgpp::base::OperationMatrixSP &  SystemMatrix, sgpp::base::DataVectorSP &  alpha, sgpp::base::DataVectorSP &  b, bool  reuse = false, bool  verbose = false, float  max_threshold = DEFAULT_RES_THRESHOLD  )

pure virtual

Pure virtual Function that defines a solve method for an iterative solver.

Parameters

SystemMatrix	reference to an sgpp::base::OperationMatrix Object that implements the matrix vector multiplication
alpha	the sparse grid's coefficients which have to be determined
b	the right hand side of the system of linear equations
reuse	identifies if the alphas, stored in alpha at calling time, should be reused
verbose	prints information during execution of the solver
max_threshold	additional abort criteria for solver, default value is 10^-9!

Implemented in sgpp::solver::ConjugateGradientsSP, and sgpp::solver::BiCGStabSP.

Referenced by sgpp::datadriven::LearnerBaseSP::train(), and ~SLESolverSP().

---

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

• solver/src/sgpp/solver/SLESolverSP.hpp