RVLUmin::PowerStep< Scalar > Class Template Reference

This Algorithm does a single iteration of the Power Method for estimating the largest singular value of a linear operator. More...

#include <pow.hh>

Inheritance diagram for RVLUmin::PowerStep< Scalar >:

RVLAlg::Algorithm List of all members.

Public Member Functions

 PowerStep (RVL::Vector< Scalar > &_x, const LinearOp< Scalar > &_A, AScalar &_sig, AScalar &_err)
 Constructor parameters:.
void run ()
 Execute a single power step.

Detailed Description

template<class Scalar>
class RVLUmin::PowerStep< Scalar >

This Algorithm does a single iteration of the Power Method for estimating the largest singular value of a linear operator.

It also estimates the relative residual |lam -rq|/|lam|, in which lam is the eigenvalue of the normal operator which the Rayleigh quotient rq approximates.

Definition at line 56 of file pow.hh.


Constructor & Destructor Documentation

template<class Scalar>
RVLUmin::PowerStep< Scalar >::PowerStep ( RVL::Vector< Scalar > &  _x,
const LinearOp< Scalar > &  _A,
AScalar &  _sig,
AScalar &  _err 
)

Constructor parameters:.

Parameters:
_x = estimated singular vector - mutable reference, updated on return
_A = linear operator for which singular pair is sought - const reference
_sig = estimated max singular value - mutable reference, updated on return
_err = estimate of relative error in singular value - mutable reference, updated on return

Definition at line 82 of file pow.hh.


Member Function Documentation

template<class Scalar>
void RVLUmin::PowerStep< Scalar >::run (  )  [virtual]

Execute a single power step.

Implements RVLAlg::Algorithm.

Definition at line 106 of file pow.hh.


The documentation for this class was generated from the following file:
Generated on 5 Jan 2017 for RvlUmin by  doxygen 1.4.7