ViennaCL - The Vienna Computing Library  1.5.1
Public Member Functions
fspai_tag Class Reference

A tag for FSPAI. Experimental. Contains values for the algorithm. Must be passed to spai_precond constructor. More...

#include <fspai.hpp>

Public Member Functions

 fspai_tag (double residual_norm_threshold=1e-3, unsigned int iteration_limit=5, bool is_static=false, bool is_right=false)
 Constructor. More...
 
double getResidualNormThreshold () const
 
unsigned long getIterationLimit () const
 
bool getIsStatic () const
 
bool getIsRight () const
 
void setResidualNormThreshold (double residual_norm_threshold)
 
void setIterationLimit (unsigned long iteration_limit)
 
void setIsRight (bool is_right)
 
void setIsStatic (bool is_static)
 

Detailed Description

A tag for FSPAI. Experimental. Contains values for the algorithm. Must be passed to spai_precond constructor.

Constructor & Destructor Documentation

fspai_tag ( double  residual_norm_threshold = 1e-3,
unsigned int  iteration_limit = 5,
bool  is_static = false,
bool  is_right = false 
)
inline

Constructor.

Parameters
residual_norm_thresholdCalculate until the norm of the residual falls below this threshold
iteration_limitmaximum number of iterations
is_staticdetermines if static version of SPAI should be used
is_rightdetermines if left or right preconditioner should be used

Member Function Documentation

bool getIsRight ( ) const
inline
bool getIsStatic ( ) const
inline
unsigned long getIterationLimit ( ) const
inline
double getResidualNormThreshold ( ) const
inline
void setIsRight ( bool  is_right)
inline
void setIsStatic ( bool  is_static)
inline
void setIterationLimit ( unsigned long  iteration_limit)
inline
void setResidualNormThreshold ( double  residual_norm_threshold)
inline

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