All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
NetworKit::GaussSeidelRelaxation< Matrix > Class Template Reference

Implementation of the Gauss-Seidel smoother. More...

#include <GaussSeidelRelaxation.h>

Public Member Functions

 GaussSeidelRelaxation (double tolerance=1e-15)
 Constructs a Gauss-Seidel smoother with the given tolerance (default: 1e-15). More...
 
Vector relax (const Matrix &A, const Vector &b, const Vector &initialGuess, const count maxIterations=std::numeric_limits< count >::max()) const
 Utilizes Gauss-Seidel relaxations until the given number of maxIterations is reached or the relative residual is below the tolerance specified in the constructor. More...
 
Vector relax (const Matrix &A, const Vector &b, const count maxIterations=std::numeric_limits< count >::max()) const
 Utilizes Gauss-Seidel relaxations until the given number of maxIterations is reached or the relative residual is below the tolerance specified in the constructor. More...
 
- Public Member Functions inherited from NetworKit::Smoother< Matrix >
 Smoother ()
 
virtual ~Smoother ()
 

Detailed Description

template<class Matrix>
class NetworKit::GaussSeidelRelaxation< Matrix >

Implementation of the Gauss-Seidel smoother.

Constructor & Destructor Documentation

template<class Matrix>
NetworKit::GaussSeidelRelaxation< Matrix >::GaussSeidelRelaxation ( double  tolerance = 1e-15)
inline

Constructs a Gauss-Seidel smoother with the given tolerance (default: 1e-15).

Parameters
tolerance

Member Function Documentation

template<class Matrix>
Vector NetworKit::GaussSeidelRelaxation< Matrix >::relax ( const Matrix A,
const Vector b,
const Vector initialGuess,
const count  maxIterations = std::numeric_limits<count>::max() 
) const
virtual

Utilizes Gauss-Seidel relaxations until the given number of maxIterations is reached or the relative residual is below the tolerance specified in the constructor.

The solver starts with initialGuess as intitial guess to the solution.

Parameters
AThe matrix.
bThe right-hand-side.
initialGuess
maxIterations
Returns
The (approximate) solution to the system.

Implements NetworKit::Smoother< Matrix >.

template<class Matrix>
Vector NetworKit::GaussSeidelRelaxation< Matrix >::relax ( const Matrix A,
const Vector b,
const count  maxIterations = std::numeric_limits<count>::max() 
) const
virtual

Utilizes Gauss-Seidel relaxations until the given number of maxIterations is reached or the relative residual is below the tolerance specified in the constructor.

Parameters
AThe matrix.
bThe right-hand-side.
maxIterations
Returns
The (approximate) solution to the system.

Implements NetworKit::Smoother< Matrix >.


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