A tag for the conjugate gradient Used for supplying solver parameters and for dispatching the solve() function.
More...
#include <cg.hpp>
Public Member Functions |
| cg_tag (double tol=1e-8, unsigned int max_iterations=300) |
| The constructor.
|
double | tolerance () const |
| Returns the relative tolerance.
|
unsigned int | max_iterations () const |
| Returns the maximum number of iterations.
|
unsigned int | iters () const |
| Return the number of solver iterations:
|
void | iters (unsigned int i) const |
double | error () const |
| Returns the estimated relative error at the end of the solver run.
|
void | error (double e) const |
| Sets the estimated relative error at the end of the solver run.
|
Detailed Description
A tag for the conjugate gradient Used for supplying solver parameters and for dispatching the solve() function.
Constructor & Destructor Documentation
cg_tag |
( |
double |
tol = 1e-8 , |
|
|
unsigned int |
max_iterations = 300 |
|
) |
| |
|
inline |
The constructor.
- Parameters
-
tol | Relative tolerance for the residual (solver quits if ||r|| < tol * ||r_initial||) |
max_iterations | The maximum number of iterations |
Member Function Documentation
Returns the estimated relative error at the end of the solver run.
void error |
( |
double |
e | ) |
const |
|
inline |
Sets the estimated relative error at the end of the solver run.
unsigned int iters |
( |
| ) |
const |
|
inline |
Return the number of solver iterations:
void iters |
( |
unsigned int |
i | ) |
const |
|
inline |
unsigned int max_iterations |
( |
| ) |
const |
|
inline |
Returns the maximum number of iterations.
double tolerance |
( |
| ) |
const |
|
inline |
Returns the relative tolerance.
The documentation for this class was generated from the following file:
- /build/buildd/viennacl-1.2.0/viennacl/linalg/cg.hpp