ViennaCL - The Vienna Computing Library  1.7.1
Free open-source GPU-accelerated linear algebra and solver library.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
viennacl::linalg::power_iter_tag Class Reference

A tag for the power iteration algorithm. More...

#include <power_iter.hpp>

Public Member Functions

 power_iter_tag (double tfac=1e-8, vcl_size_t max_iters=50000)
 The constructor. More...
void factor (double fct)
 Sets the factor for termination. More...
double factor () const
 Returns the factor for termination. More...
vcl_size_t max_iterations () const
void max_iterations (vcl_size_t new_max)

Detailed Description

A tag for the power iteration algorithm.


Definition at line 38 of file power_iter.hpp.

Constructor & Destructor Documentation

viennacl::linalg::power_iter_tag::power_iter_tag ( double  tfac = 1e-8,
vcl_size_t  max_iters = 50000 

The constructor.

tfacIf the eigenvalue does not change more than this termination factor, the algorithm stops
max_itersMaximum number of iterations for the power iteration

Definition at line 47 of file power_iter.hpp.

Member Function Documentation

void viennacl::linalg::power_iter_tag::factor ( double  fct)

Sets the factor for termination.

Definition at line 50 of file power_iter.hpp.

double viennacl::linalg::power_iter_tag::factor ( ) const

Returns the factor for termination.

Definition at line 53 of file power_iter.hpp.

vcl_size_t viennacl::linalg::power_iter_tag::max_iterations ( ) const

Definition at line 55 of file power_iter.hpp.

void viennacl::linalg::power_iter_tag::max_iterations ( vcl_size_t  new_max)

Definition at line 56 of file power_iter.hpp.

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