Anasazi::StatusTest< ScalarType, MV, OP > Class Template Reference

A pure virtual class for defining the status tests for the Anasazi iterative solvers. More...

#include <AnasaziStatusTestDecl.hpp>

Inheritance diagram for Anasazi::StatusTest< ScalarType, MV, OP >:
Anasazi::StatusTestCombo< ScalarType, MV, OP > Anasazi::StatusTestMaxIters< ScalarType, MV, OP > Anasazi::StatusTestOutput< ScalarType, MV, OP > Anasazi::StatusTestResNorm< ScalarType, MV, OP > Anasazi::StatusTestWithOrdering< ScalarType, MV, OP >

List of all members.

Public Member Functions

Constructors/destructors

 StatusTest ()
 Constructor.
virtual ~StatusTest ()
 Destructor.
Status methods

virtual TestStatus checkStatus (Eigensolver< ScalarType, MV, OP > *solver)=0
virtual TestStatus getStatus () const =0
 Return the result of the most recent checkStatus call, or undefined if it has not been run.
virtual std::vector< int > whichVecs () const =0
 Get the indices for the vectors that passed the test.
virtual int howMany () const =0
 Get the number of vectors that passed the test.
Reset methods

virtual void reset ()=0
 Informs the status test that it should reset its internal configuration to the uninitialized state.
virtual void clearStatus ()=0
 Clears the results of the last status test.
Print methods

virtual std::ostream & print (std::ostream &os, int indent=0) const =0
 Output formatted description of stopping test to output stream.

Detailed Description

template<class ScalarType, class MV, class OP>
class Anasazi::StatusTest< ScalarType, MV, OP >

A pure virtual class for defining the status tests for the Anasazi iterative solvers.

StatusTest is an interface that can be implemented to create convergence tests for all Anasazi solvers. Almost any kind of test can be expressed using this mechanism, including composite tests (see StatusTestCombo).

Definition at line 59 of file AnasaziStatusTest.hpp.


Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >
Anasazi::StatusTest< ScalarType, MV, OP >::StatusTest (  )  [inline]

Constructor.

Definition at line 66 of file AnasaziStatusTest.hpp.

template<class ScalarType , class MV , class OP >
virtual Anasazi::StatusTest< ScalarType, MV, OP >::~StatusTest (  )  [inline, virtual]

Destructor.

Definition at line 69 of file AnasaziStatusTest.hpp.


Member Function Documentation

template<class ScalarType , class MV , class OP >
virtual TestStatus Anasazi::StatusTest< ScalarType, MV, OP >::checkStatus ( Eigensolver< ScalarType, MV, OP > *  solver  )  [pure virtual]
template<class ScalarType , class MV , class OP >
virtual TestStatus Anasazi::StatusTest< ScalarType, MV, OP >::getStatus (  )  const [pure virtual]
template<class ScalarType , class MV , class OP >
virtual std::vector<int> Anasazi::StatusTest< ScalarType, MV, OP >::whichVecs (  )  const [pure virtual]
template<class ScalarType , class MV , class OP >
virtual int Anasazi::StatusTest< ScalarType, MV, OP >::howMany (  )  const [pure virtual]
template<class ScalarType , class MV , class OP >
virtual void Anasazi::StatusTest< ScalarType, MV, OP >::reset (  )  [pure virtual]

Informs the status test that it should reset its internal configuration to the uninitialized state.

This is necessary for the case when the status test is being reused by another solver or for another eigenvalue problem. The status test may have information that pertains to a particular problem or solver state. The internal information will be reset back to the uninitialized state. The user specified information that the convergence test uses will remain.

Implemented in Anasazi::StatusTestCombo< ScalarType, MV, OP >, Anasazi::StatusTestMaxIters< ScalarType, MV, OP >, Anasazi::StatusTestOutput< ScalarType, MV, OP >, Anasazi::StatusTestResNorm< ScalarType, MV, OP >, and Anasazi::StatusTestWithOrdering< ScalarType, MV, OP >.

template<class ScalarType , class MV , class OP >
virtual void Anasazi::StatusTest< ScalarType, MV, OP >::clearStatus (  )  [pure virtual]

Clears the results of the last status test.

This should be distinguished from the reset() method, as it only clears the cached result from the last status test, so that a call to getStatus() will return Undefined. This is necessary for the SEQOR and SEQAND tests in the StatusTestCombo class, which may short circuit and not evaluate all of the StatusTests contained in them.

Implemented in Anasazi::StatusTestCombo< ScalarType, MV, OP >, Anasazi::StatusTestMaxIters< ScalarType, MV, OP >, Anasazi::StatusTestOutput< ScalarType, MV, OP >, Anasazi::StatusTestResNorm< ScalarType, MV, OP >, and Anasazi::StatusTestWithOrdering< ScalarType, MV, OP >.

template<class ScalarType , class MV , class OP >
virtual std::ostream& Anasazi::StatusTest< ScalarType, MV, OP >::print ( std::ostream &  os,
int  indent = 0 
) const [pure virtual]

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Generated on Wed Apr 13 09:57:00 2011 for Anasazi by  doxygen 1.6.3