ViennaCL - The Vienna Computing Library  1.5.2
Public Types | Public Member Functions
lanczos_tag Class Reference

A tag for the lanczos algorithm. More...

#include <lanczos.hpp>

Public Types

enum  { partial_reorthogonalization = 0, full_reorthogonalization, no_reorthogonalization }
 

Public Member Functions

 lanczos_tag (double factor=0.75, vcl_size_t numeig=10, int met=0, vcl_size_t krylov=100)
 The constructor. More...
 
void num_eigenvalues (int numeig)
 Sets the number of eigenvalues. More...
 
vcl_size_t num_eigenvalues () const
 Returns the number of eigenvalues. More...
 
void factor (double fct)
 Sets the exponent of epsilon. More...
 
double factor () const
 Returns the exponent. More...
 
void krylov_size (int max)
 Sets the size of the kylov space. More...
 
vcl_size_t krylov_size () const
 Returns the size of the kylov space. More...
 
void method (int met)
 Sets the reorthogonalization method. More...
 
int method () const
 Returns the reorthogonalization method. More...
 

Detailed Description

A tag for the lanczos algorithm.

Member Enumeration Documentation

anonymous enum
Enumerator
partial_reorthogonalization 
full_reorthogonalization 
no_reorthogonalization 

Constructor & Destructor Documentation

lanczos_tag ( double  factor = 0.75,
vcl_size_t  numeig = 10,
int  met = 0,
vcl_size_t  krylov = 100 
)
inline

The constructor.

Parameters
factorExponent of epsilon - tolerance for batches of Reorthogonalization
numeigNumber of eigenvalues to be returned
metMethod for Lanczos-Algorithm: 0 for partial Reorthogonalization, 1 for full Reorthogonalization and 2 for Lanczos without Reorthogonalization
krylovMaximum krylov-space size

Member Function Documentation

void factor ( double  fct)
inline

Sets the exponent of epsilon.

double factor ( ) const
inline

Returns the exponent.

void krylov_size ( int  max)
inline

Sets the size of the kylov space.

vcl_size_t krylov_size ( ) const
inline

Returns the size of the kylov space.

void method ( int  met)
inline

Sets the reorthogonalization method.

int method ( ) const
inline

Returns the reorthogonalization method.

void num_eigenvalues ( int  numeig)
inline

Sets the number of eigenvalues.

vcl_size_t num_eigenvalues ( ) const
inline

Returns the number of eigenvalues.


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