A tag for SPAI.  
 More...
#include <spai_tag.hpp>
A tag for SPAI. 
Contains values for the algorithm. Must be passed to spai_precond constructor 
- Examples: 
- spai.cpp.
Definition at line 64 of file spai_tag.hpp.
  
  | 
        
          | viennacl::linalg::detail::spai::spai_tag::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 |  
 
Definition at line 75 of file spai_tag.hpp.
 
 
  
  | 
        
          | long viennacl::linalg::detail::spai::spai_tag::getBegInd | ( |  | ) | const |  | inline | 
 
 
  
  | 
        
          | long viennacl::linalg::detail::spai::spai_tag::getEndInd | ( |  | ) | const |  | inline | 
 
 
  
  | 
        
          | bool viennacl::linalg::detail::spai::spai_tag::getIsRight | ( |  | ) | const |  | inline | 
 
 
  
  | 
        
          | bool viennacl::linalg::detail::spai::spai_tag::getIsStatic | ( |  | ) | const |  | inline | 
 
 
  
  | 
        
          | unsigned int viennacl::linalg::detail::spai::spai_tag::getIterationLimit | ( |  | ) | const |  | inline | 
 
 
  
  | 
        
          | double viennacl::linalg::detail::spai::spai_tag::getResidualNormThreshold | ( |  | ) | const |  | inline | 
 
 
  
  | 
        
          | double viennacl::linalg::detail::spai::spai_tag::getResidualThreshold | ( |  | ) | const |  | inline | 
 
 
  
  | 
        
          | void viennacl::linalg::detail::spai::spai_tag::setBegInd | ( | long | beg_ind | ) |  |  | inline | 
 
 
  
  | 
        
          | void viennacl::linalg::detail::spai::spai_tag::setEndInd | ( | long | end_ind | ) |  |  | inline | 
 
 
  
  | 
        
          | void viennacl::linalg::detail::spai::spai_tag::setIsRight | ( | bool | is_right | ) |  |  | inline | 
 
 
  
  | 
        
          | void viennacl::linalg::detail::spai::spai_tag::setIsStatic | ( | bool | is_static | ) |  |  | inline | 
 
 
  
  | 
        
          | void viennacl::linalg::detail::spai::spai_tag::setIterationLimit | ( | unsigned int | iteration_limit | ) |  |  | inline | 
 
 
  
  | 
        
          | void viennacl::linalg::detail::spai::spai_tag::setResidualNormThreshold | ( | double | residual_norm_threshold | ) |  |  | inline | 
 
 
  
  | 
        
          | void viennacl::linalg::detail::spai::spai_tag::setResidualThreshold | ( | double | residual_threshold | ) |  |  | inline | 
 
 
The documentation for this class was generated from the following file: