SG++-Doxygen-Documentation
sgpp::solver::SGSolverSP Class Reference

Abstract class that defines a solver used in Sparse Grids Applications. More...

#include <SGSolverSP.hpp>

Inheritance diagram for sgpp::solver::SGSolverSP:
sgpp::solver::SLESolverSP sgpp::solver::BiCGStabSP sgpp::solver::ConjugateGradientsSP

Public Member Functions

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...
 

Protected Attributes

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...
 

Detailed Description

Abstract class that defines a solver used in Sparse Grids Applications.

Constructor & Destructor Documentation

◆ SGSolverSP()

sgpp::solver::SGSolverSP::SGSolverSP ( size_t  nMaximumIterations,
float  epsilon 
)
inline

Std-Constructor.

Parameters
nMaximumIterationsnumber of maximum executed iterations
epsilonthe final error in the iterative solver, or the size of one timestep

◆ ~SGSolverSP()

virtual sgpp::solver::SGSolverSP::~SGSolverSP ( )
inlinevirtual

Std-Destructor.

Member Function Documentation

◆ getEpsilon()

float sgpp::solver::SGSolverSP::getEpsilon ( )
inline

gets the the epsilon, that is used in the SGSolver

Returns
the epsilon, used in the solver

References myEpsilon.

◆ getNumberIterations()

size_t sgpp::solver::SGSolverSP::getNumberIterations ( )
inline

function that returns the number of needed solve steps

Returns
the number of needed solve steps of the sovler

References nIterations.

Referenced by sgpp::datadriven::LearnerBaseSP::train().

◆ getResiduum()

float sgpp::solver::SGSolverSP::getResiduum ( )
inline

function the returns the residuum (current or final), error of the solver

Returns
the residuum

References residuum.

Referenced by sgpp::datadriven::LearnerBaseSP::train().

◆ setEpsilon()

void sgpp::solver::SGSolverSP::setEpsilon ( float  eps)
inline

resets the epsilon, that is used in the SGSolver

Parameters
epsthe new value of epsilon

References friedman::eps.

Referenced by sgpp::datadriven::LearnerBaseSP::train().

◆ setMaxIterations()

void sgpp::solver::SGSolverSP::setMaxIterations ( size_t  nIterations)
inline

resets the number of maximum iterations

Parameters
nIterationsthe new number of maximum iterations

References nIterations.

Referenced by python.learner.solver.CGSolver.CGSolver::setImax(), and sgpp::datadriven::LearnerBaseSP::train().

Member Data Documentation

◆ myEpsilon

float sgpp::solver::SGSolverSP::myEpsilon
protected

epsilon needed in the, e.g. final error in the iterative solver, or a timestep

Referenced by python.learner.solver.CGSolver.CGSolver::getEpsilon(), getEpsilon(), sgpp::solver::BiCGStabSP::solve(), and sgpp::solver::ConjugateGradientsSP::solve().

◆ nIterations

size_t sgpp::solver::SGSolverSP::nIterations
protected

◆ nMaxIterations

size_t sgpp::solver::SGSolverSP::nMaxIterations
protected

◆ residuum

float sgpp::solver::SGSolverSP::residuum
protected

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