SG++-Doxygen-Documentation
sgpp::optimization::sle_solver::BiCGStab Class Reference

Linear system solver implementing the iterative BiCGStab method. More...

#include <BiCGStab.hpp>

Inheritance diagram for sgpp::optimization::sle_solver::BiCGStab:
sgpp::optimization::sle_solver::SLESolver

Public Member Functions

 BiCGStab ()
 Constructor. More...
 
 BiCGStab (size_t maxItCount, double tolerance, const base::DataVector &startingPoint)
 
size_t getMaxItCount () const
 
const base::DataVectorgetStartingPoint () const
 
double getTolerance () const
 
void setMaxItCount (size_t maxItCount)
 
void setStartingPoint (const base::DataVector &startingPoint)
 
void setTolerance (double tolerance)
 
bool solve (SLE &system, base::DataVector &b, base::DataVector &x) const override
 
 ~BiCGStab () override
 Destructor. More...
 
- Public Member Functions inherited from sgpp::optimization::sle_solver::SLESolver
 SLESolver ()
 Constructor. More...
 
virtual bool solve (SLE &system, base::DataMatrix &B, base::DataMatrix &X) const
 Virtual method for solving multiple linear systems with different right-hand sides. More...
 
virtual ~SLESolver ()
 Destructor. More...
 

Static Public Attributes

static const size_t DEFAULT_MAX_IT_COUNT = 1000
 default maximal number of iterations More...
 
static constexpr double DEFAULT_TOLERANCE = 1e-10
 default tolerance More...
 

Protected Attributes

size_t N
 maximal number of iterations More...
 
double tol
 tolerance More...
 
base::DataVector x0
 starting vector More...
 

Detailed Description

Linear system solver implementing the iterative BiCGStab method.

Constructor & Destructor Documentation

sgpp::optimization::sle_solver::BiCGStab::BiCGStab ( )

Constructor.

sgpp::optimization::sle_solver::BiCGStab::BiCGStab ( size_t  maxItCount,
double  tolerance,
const base::DataVector startingPoint 
)
Parameters
maxItCountmaximal number of iterations
tolerancetolerance
startingPointstarting vector
sgpp::optimization::sle_solver::BiCGStab::~BiCGStab ( )
override

Destructor.

Member Function Documentation

size_t sgpp::optimization::sle_solver::BiCGStab::getMaxItCount ( ) const
Returns
maximal number of iterations

References N.

const base::DataVector & sgpp::optimization::sle_solver::BiCGStab::getStartingPoint ( ) const
Returns
starting vector

References x0.

double sgpp::optimization::sle_solver::BiCGStab::getTolerance ( ) const
Returns
tolerance

References tol.

void sgpp::optimization::sle_solver::BiCGStab::setMaxItCount ( size_t  maxItCount)
Parameters
maxItCountmaximal number of iterations

References N.

void sgpp::optimization::sle_solver::BiCGStab::setStartingPoint ( const base::DataVector startingPoint)
Parameters
startingPointstarting vector

References sgpp::base::DataVector::getSize(), and x0.

void sgpp::optimization::sle_solver::BiCGStab::setTolerance ( double  tolerance)
Parameters
tolerancetolerance

References tol.

Member Data Documentation

const size_t sgpp::optimization::sle_solver::BiCGStab::DEFAULT_MAX_IT_COUNT = 1000
static

default maximal number of iterations

constexpr double sgpp::optimization::sle_solver::BiCGStab::DEFAULT_TOLERANCE = 1e-10
static

default tolerance

size_t sgpp::optimization::sle_solver::BiCGStab::N
protected

maximal number of iterations

Referenced by getMaxItCount(), setMaxItCount(), and solve().

double sgpp::optimization::sle_solver::BiCGStab::tol
protected

tolerance

Referenced by getTolerance(), setTolerance(), and solve().

base::DataVector sgpp::optimization::sle_solver::BiCGStab::x0
protected

starting vector

Referenced by getStartingPoint(), setStartingPoint(), and solve().


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