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:

Public Member Functions
	BiCGStab ()
	Constructor. More...
	BiCGStab (size_t maxItCount, double tolerance, const base::DataVector &startingPoint)
size_t	getMaxItCount () const
const base::DataVector &	getStartingPoint () 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

BiCGStab() [1/2]

sgpp::optimization::sle_solver::BiCGStab::BiCGStab

(

)

Constructor.

BiCGStab() [2/2]

sgpp::optimization::sle_solver::BiCGStab::BiCGStab	(	size_t	maxItCount,
		double	tolerance,
		const base::DataVector &	startingPoint
	)

Parameters

maxItCount	maximal number of iterations
tolerance	tolerance
startingPoint	starting vector

~BiCGStab()

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

override

Destructor.

Member Function Documentation

getMaxItCount()

size_t sgpp::optimization::sle_solver::BiCGStab::getMaxItCount

(

)

const

Returns

maximal number of iterations

References N.

getStartingPoint()

const base::DataVector & sgpp::optimization::sle_solver::BiCGStab::getStartingPoint

(

)

const

Returns

starting vector

References x0.

getTolerance()

double sgpp::optimization::sle_solver::BiCGStab::getTolerance

(

)

const

Returns

tolerance

References tol.

setMaxItCount()

void sgpp::optimization::sle_solver::BiCGStab::setMaxItCount

(

size_t

maxItCount

)

Parameters

maxItCount

maximal number of iterations

References N.

setStartingPoint()

void sgpp::optimization::sle_solver::BiCGStab::setStartingPoint

(

const base::DataVector &

startingPoint

)

Parameters

startingPoint

starting vector

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

setTolerance()

void sgpp::optimization::sle_solver::BiCGStab::setTolerance

(

double

tolerance

)

Parameters

tolerance

tolerance

References tol.

solve()

bool sgpp::optimization::sle_solver::BiCGStab::solve ( SLE &  system, base::DataVector &  b, base::DataVector &  x  ) const

overridevirtual

Parameters

	system	system to be solved
	b	right-hand side
[out]	x	solution to the system

Returns

whether all went well (false if errors occurred)

Implements sgpp::optimization::sle_solver::SLESolver.

References alpha, sgpp::base::DataVector::dotProduct(), sgpp::optimization::Printer::getInstance(), sgpp::optimization::SLE::getMatrixEntry(), sgpp::base::DataVector::getSize(), python.statsfileInfo::i, sgpp::optimization::SLE::matrixVectorMultiplication(), N, friedman::p, sgpp::optimization::Printer::printStatusBegin(), sgpp::optimization::Printer::printStatusEnd(), sgpp::optimization::Printer::printStatusUpdate(), chess::r, create_scripts::s, sgpp::base::DataVector::setAll(), tol, and x0.

Member Data Documentation

DEFAULT_MAX_IT_COUNT

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

static

default maximal number of iterations

DEFAULT_TOLERANCE

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

static

default tolerance

N

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

protected

maximal number of iterations

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

tol

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

protected

tolerance

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

x0

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:

• optimization/src/sgpp/optimization/sle/solver/BiCGStab.hpp
• optimization/src/sgpp/optimization/sle/solver/BiCGStab.cpp