Anasazi Version of the Day

Mixin for outofplace orthogonalization. More...
#include <AnasaziTsqrOrthoManager.hpp>
Public Types  
typedef MV  multivector_type 
Multivector type with which this class was specialized.  
Public Member Functions  
virtual int  normalizeOutOfPlace (MV &X, MV &Q, mat_ptr B) const =0 
Normalize X into Q*B.  
virtual int  projectAndNormalizeOutOfPlace (MV &X_in, MV &X_out, Teuchos::Array< mat_ptr > C, mat_ptr B, Teuchos::ArrayView< Teuchos::RCP< const MV > > Q) const =0 
Project and normalize X_in into X_out.  
virtual  ~OutOfPlaceNormalizerMixin () 
Trivial virtual destructor, to silence compiler warnings. 
Mixin for outofplace orthogonalization.
This class presents an abstract interface for multiple inheritance ("mixin") for special orthogonalization methods that normalize "outofplace." OrthoManager and MatOrthoManager both normalize (and projectAndNormalize) multivectors "in place," meaning that the input and output multivectors are the same (X, in both cases). GramSchmidt (modified or classical) is an example of an orthogonalization method that can normalize (and projectAndNormalize) in place. TSQR (the Tall Skinny QR factorization, see TsqrOrthoManager.hpp
for references) is an orthogonalization method which cannot normalize (or projectAndNormalize) in place.
Tsqr(Mat)OrthoManager implements (Mat)OrthoManager's normalize() and projectAndNormalize() methods with scratch space and copying. However, if you handle Tsqr(Mat)OrthoManager through this mixin, you can exploit TSQR's unique interface to avoid copying back and forth between scratch space.
Definition at line 63 of file AnasaziTsqrOrthoManager.hpp.
Anasazi::OutOfPlaceNormalizerMixin< Scalar, MV >::multivector_type 
Multivector type with which this class was specialized.
Reimplemented in Anasazi::TsqrOrthoManager< Scalar, MV >, and Anasazi::TsqrMatOrthoManager< Scalar, MV, OP >.
Definition at line 69 of file AnasaziTsqrOrthoManager.hpp.
virtual Anasazi::OutOfPlaceNormalizerMixin< Scalar, MV >::~OutOfPlaceNormalizerMixin  (  )  [inline, virtual] 
Trivial virtual destructor, to silence compiler warnings.
Definition at line 111 of file AnasaziTsqrOrthoManager.hpp.
virtual int Anasazi::OutOfPlaceNormalizerMixin< Scalar, MV >::normalizeOutOfPlace  (  MV &  X, 
MV &  Q,  
mat_ptr  B  
)  const [pure virtual] 
Normalize X into Q*B.
X  [in/out] On input: Multivector to normalize. On output: Possibly overwritten with invalid values. 
Q  [out] On output: Normalized multivector. 
B  [out] On output: Normalization coefficients. 
Implemented in Anasazi::TsqrOrthoManager< Scalar, MV >, and Anasazi::TsqrMatOrthoManager< Scalar, MV, OP >.
virtual int Anasazi::OutOfPlaceNormalizerMixin< Scalar, MV >::projectAndNormalizeOutOfPlace  (  MV &  X_in, 
MV &  X_out,  
Teuchos::Array< mat_ptr >  C,  
mat_ptr  B,  
Teuchos::ArrayView< Teuchos::RCP< const MV > >  Q  
)  const [pure virtual] 
Project and normalize X_in into X_out.
Project X_in against Q, storing projection coefficients in C, and normalize X_in into X_out, storing normalization coefficients in B. On output, X_out has the resulting orthogonal vectors. X_in may be overwritten with invalid values.
X_in  [in/out] On input: The vectors to project against Q and normalize. On output: possibly overwritten with invalid values. 
X_out  [out] The normalized input vectors after projection against Q. 
C  [out] Projection coefficients 
B  [out] Normalization coefficients 
Q  [in] The orthogonal basis against which to project 
Implemented in Anasazi::TsqrOrthoManager< Scalar, MV >, and Anasazi::TsqrMatOrthoManager< Scalar, MV, OP >.