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

A tag for the stabilized Bi-conjugate gradient solver. Used for supplying solver parameters and for dispatching the solve() function. More...

#include <bicgstab.hpp>

Public Member Functions

 bicgstab_tag (double tol=1e-8, vcl_size_t max_iters=400, vcl_size_t max_iters_before_restart=200)
 The constructor. More...
 
double tolerance () const
 Returns the relative tolerance. More...
 
vcl_size_t max_iterations () const
 Returns the maximum number of iterations. More...
 
vcl_size_t max_iterations_before_restart () const
 Returns the maximum number of iterations before a restart. More...
 
vcl_size_t iters () const
 Return the number of solver iterations: More...
 
void iters (vcl_size_t i) const
 
double error () const
 Returns the estimated relative error at the end of the solver run. More...
 
void error (double e) const
 Sets the estimated relative error at the end of the solver run. More...
 

Detailed Description

A tag for the stabilized Bi-conjugate gradient solver. Used for supplying solver parameters and for dispatching the solve() function.

Constructor & Destructor Documentation

bicgstab_tag ( double  tol = 1e-8,
vcl_size_t  max_iters = 400,
vcl_size_t  max_iters_before_restart = 200 
)
inline

The constructor.

Parameters
tolRelative tolerance for the residual (solver quits if ||r|| < tol * ||r_initial||)
max_itersThe maximum number of iterations
max_iters_before_restartThe maximum number of iterations before BiCGStab is reinitialized (to avoid accumulation of round-off errors)

Member Function Documentation

double error ( ) const
inline

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.

vcl_size_t iters ( ) const
inline

Return the number of solver iterations:

void iters ( vcl_size_t  i) const
inline
vcl_size_t max_iterations ( ) const
inline

Returns the maximum number of iterations.

vcl_size_t max_iterations_before_restart ( ) const
inline

Returns the maximum number of iterations before a restart.

double tolerance ( ) const
inline

Returns the relative tolerance.


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