A tag for SPAI Contains values for the algorithm. Must be passed to spai_precond constructor.
More...
#include <spai_tag.hpp>
Detailed Description
A tag for SPAI Contains values for the algorithm. Must be passed to spai_precond constructor.
Constructor & Destructor Documentation
| spai_tag |
( |
double |
residual_norm_threshold = 1e-3, |
|
|
unsigned int |
iteration_limit = 5, |
|
|
double |
residual_threshold = 1e-2, |
|
|
bool |
is_static = false, |
|
|
bool |
is_right = false |
|
) |
| |
|
inline |
Constructor.
- Parameters
-
| residual_norm_threshold | Calculate until the norm of the residual falls below this threshold |
| iteration_limit | maximum number of iterations |
| residual_threshold | determines starting threshold in residual vector for including new indices into set J |
| is_static | determines if static version of SPAI should be used |
| is_right | determines if left or right preconditioner should be used |
Member Function Documentation
| bool getIsRight |
( |
| ) |
const |
|
inline |
| bool getIsStatic |
( |
| ) |
const |
|
inline |
| unsigned int getIterationLimit |
( |
| ) |
const |
|
inline |
| double getResidualNormThreshold |
( |
| ) |
const |
|
inline |
| double getResidualThreshold |
( |
| ) |
const |
|
inline |
| void setBegInd |
( |
long |
beg_ind | ) |
|
|
inline |
| void setEndInd |
( |
long |
end_ind | ) |
|
|
inline |
| void setIsRight |
( |
bool |
is_right | ) |
|
|
inline |
| void setIsStatic |
( |
bool |
is_static | ) |
|
|
inline |
| void setIterationLimit |
( |
unsigned int |
iteration_limit | ) |
|
|
inline |
| void setResidualNormThreshold |
( |
double |
residual_norm_threshold | ) |
|
|
inline |
| void setResidualThreshold |
( |
double |
residual_threshold | ) |
|
|
inline |
The documentation for this class was generated from the following file:
- /tmp/buildd/viennacl-1.2.0/viennacl/linalg/detail/spai/spai_tag.hpp
