#include <AnasaziStatusTestCombo.hpp>
Inheritance diagram for Anasazi::StatusTestCombo< ScalarType, MV, OP >:
Public Types | |
| OR | |
| AND | |
| SEQOR | |
| SEQAND | |
| enum | ComboType { OR, AND, SEQOR, SEQAND } |
| Enumerated type to list the types of StatusTestCombo combo types. More... | |
Public Member Functions | |
Constructors/destructors | |
| StatusTestCombo () | |
| Default constructor has no tests and initializes to StatusTestCombo::ComboType StatusTestCombo::OR. | |
| StatusTestCombo (ComboType type, Teuchos::Array< Teuchos::RCP< StatusTest< ScalarType, MV, OP > > > tests) | |
| Constructor specifying the StatusTestCombo::ComboType and the tests. | |
| virtual | ~StatusTestCombo () |
| Destructor. | |
Status methods | |
| TestStatus | checkStatus (Eigensolver< ScalarType, MV, OP > *solver) |
| TestStatus | getStatus () const |
| Return the result of the most recent checkStatus call. | |
| std::vector< int > | whichVecs () const |
| Get the indices for the vectors that passed the test. | |
| int | howMany () const |
| Get the number of vectors that passed the test. | |
Accessor methods | |
| void | setComboType (ComboType type) |
| Set the maximum number of iterations. This also resets the test status to Undefined. | |
| ComboType | getComboType () const |
| Get the maximum number of iterations. | |
| void | setTests (Teuchos::Array< Teuchos::RCP< StatusTest< ScalarType, MV, OP > > > tests) |
| Set the tests This also resets the test status to Undefined. | |
| Teuchos::Array< Teuchos::RCP< StatusTest< ScalarType, MV, OP > > > | getTests () const |
| Get the tests. | |
| void | addTest (Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test) |
| Add a test to the combination. | |
| void | removeTest (const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &test) |
| Removes a test from the combination, if it exists in the tester. | |
Reset methods | |
| void | reset () |
| Informs the status test that it should reset its internal configuration to the uninitialized state. | |
| void | clearStatus () |
| Clears the results of the last status test. | |
Print methods | |
| std::ostream & | print (std::ostream &os, int indent=0) const |
| Output formatted description of stopping test to output stream. | |
Test types include StatusTestCombo::OR, StatusTestCombo::AND, StatusTestCombo::SEQOR and StatusTestCombo::SEQAND. The StatusTestCombo::OR and StatusTestCombo::AND tests evaluate all of the tests, in the order they were passed to the StatusTestCombo. The StatusTestCombo::SEQOR and StatusTestCombo::SEQAND run only the tests necessary to determine the final outcome, short-circuiting on the first test that conclusively decides the outcome. More formally, StatusTestCombo::SEQAND runs the tests in the order they were given to the StatusTestCombo class and stops after the first test that evaluates Failed. StatusTestCombo::SEQOR run the tests in the order they were given to the StatusTestCombo class and stops after the first test that evaluates Passed.
| enum Anasazi::StatusTestCombo::ComboType |
Enumerated type to list the types of StatusTestCombo combo types.
| Anasazi::StatusTestCombo< ScalarType, MV, OP >::StatusTestCombo | ( | ) | [inline] |
Default constructor has no tests and initializes to StatusTestCombo::ComboType StatusTestCombo::OR.
Constructor
| Anasazi::StatusTestCombo< ScalarType, MV, OP >::StatusTestCombo | ( | ComboType | type, | |
| Teuchos::Array< Teuchos::RCP< StatusTest< ScalarType, MV, OP > > > | tests | |||
| ) | [inline] |
Constructor specifying the StatusTestCombo::ComboType and the tests.
Constructor
| virtual Anasazi::StatusTestCombo< ScalarType, MV, OP >::~StatusTestCombo | ( | ) | [inline, virtual] |
Destructor.
| TestStatus Anasazi::StatusTestCombo< ScalarType, MV, OP >::checkStatus | ( | Eigensolver< ScalarType, MV, OP > * | solver | ) | [virtual] |
Check status as defined by test.
Implements Anasazi::StatusTest< ScalarType, MV, OP >.
| TestStatus Anasazi::StatusTestCombo< ScalarType, MV, OP >::getStatus | ( | ) | const [inline, virtual] |
Return the result of the most recent checkStatus call.
Implements Anasazi::StatusTest< ScalarType, MV, OP >.
| std::vector<int> Anasazi::StatusTestCombo< ScalarType, MV, OP >::whichVecs | ( | ) | const [inline, virtual] |
Get the indices for the vectors that passed the test.
This returns some combination of the passing vectors from the tests comprising the StatusTestCombo. The nature of the combination depends on the StatusTestCombo::ComboType:
Implements Anasazi::StatusTest< ScalarType, MV, OP >.
| int Anasazi::StatusTestCombo< ScalarType, MV, OP >::howMany | ( | ) | const [inline, virtual] |
Get the number of vectors that passed the test.
Implements Anasazi::StatusTest< ScalarType, MV, OP >.
| void Anasazi::StatusTestCombo< ScalarType, MV, OP >::setComboType | ( | ComboType | type | ) | [inline] |
Set the maximum number of iterations. This also resets the test status to Undefined.
| ComboType Anasazi::StatusTestCombo< ScalarType, MV, OP >::getComboType | ( | ) | const [inline] |
Get the maximum number of iterations.
| void Anasazi::StatusTestCombo< ScalarType, MV, OP >::setTests | ( | Teuchos::Array< Teuchos::RCP< StatusTest< ScalarType, MV, OP > > > | tests | ) | [inline] |
Set the tests This also resets the test status to Undefined.
| Teuchos::Array<Teuchos::RCP<StatusTest<ScalarType,MV,OP> > > Anasazi::StatusTestCombo< ScalarType, MV, OP >::getTests | ( | ) | const [inline] |
Get the tests.
| void Anasazi::StatusTestCombo< ScalarType, MV, OP >::addTest | ( | Teuchos::RCP< StatusTest< ScalarType, MV, OP > > | test | ) | [inline] |
Add a test to the combination.
This also resets the test status to Undefined.
| void Anasazi::StatusTestCombo< ScalarType, MV, OP >::removeTest | ( | const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > & | test | ) |
Removes a test from the combination, if it exists in the tester.
This also resets the test status to Undefined, if a test was removed.
| void Anasazi::StatusTestCombo< ScalarType, MV, OP >::reset | ( | ) | [virtual] |
Informs the status test that it should reset its internal configuration to the uninitialized state.
The StatusTestCombo class has no internal state, but children classes might, so this method will call reset() on all child status tests. It also resets the test status to Undefined.
Implements Anasazi::StatusTest< ScalarType, MV, OP >.
| void Anasazi::StatusTestCombo< ScalarType, MV, OP >::clearStatus | ( | ) | [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 StatusTestCombo::SEQOR and StatusTestCombo::SEQAND tests in the StatusTestCombo class, which may short circuit and not evaluate all of the StatusTests contained in them.
Implements Anasazi::StatusTest< ScalarType, MV, OP >.
| std::ostream & Anasazi::StatusTestCombo< ScalarType, MV, OP >::print | ( | std::ostream & | os, | |
| int | indent = 0 | |||
| ) | const [virtual] |
Output formatted description of stopping test to output stream.
Implements Anasazi::StatusTest< ScalarType, MV, OP >.
1.4.7