|
Anasazi
Version of the Day
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
|
Anasazi
Version of the Day
|
A special StatusTest for printing other status tests. More...
#include <AnasaziStatusTestOutput.hpp>
Public Member Functions | |
Constructors/destructors | |
| StatusTestOutput (const Teuchos::RCP< OutputManager< ScalarType > > &printer, Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test, int mod=1, int printStates=Passed) | |
| Constructor. More... | |
| virtual | ~StatusTestOutput () |
| Destructor. More... | |
Status methods | |
| TestStatus | checkStatus (Eigensolver< ScalarType, MV, OP > *solver) |
| TestStatus | getStatus () const |
| Return the result of the most recent checkStatus call, or undefined if it has not been run. More... | |
| std::vector< int > | whichVecs () const |
| Get the indices for the vectors that passed the test. More... | |
| int | howMany () const |
| Get the number of vectors that passed the test. More... | |
Accessor methods | |
| void | setChild (Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test) |
| Set child test. More... | |
| Teuchos::RCP< StatusTest < ScalarType, MV, OP > > | getChild () const |
| Get child test. More... | |
Reset methods | |
| void | reset () |
| Informs the status test that it should reset its internal configuration to the uninitialized state. More... | |
| void | clearStatus () |
Print methods | |
| std::ostream & | print (std::ostream &os, int indent=0) const |
| Output formatted description of stopping test to output stream. More... | |
 Public Member Functions inherited from Anasazi::StatusTest< ScalarType, MV, OP > | |
| StatusTest () | |
| Constructor. More... | |
| virtual | ~StatusTest () |
| Destructor. More... | |
A special StatusTest for printing other status tests.
StatusTestOutput is a wrapper around another StatusTest that calls StatusTest::print() on the underlying object on calls to StatusTestOutput::checkStatus(). The frequency and occasion of the printing can be dictated according to some parameters passed to StatusTestOutput::StatusTestOutput().
Definition at line 40 of file AnasaziStatusTestOutput.hpp.
|
inline |
Constructor.
The StatusTestOutput requires an OutputManager for printing the underlying StatusTest on calls to checkStatus(), as well as an underlying StatusTest.
StatusTestOutput can be initialized with a null pointer for argument test. However, calling checkStatus() with a null child pointer will result in a StatusTestError exception being thrown. See checkStatus() for more information.
The last two parameters, described below, in addition to the verbosity level of the OutputManager, control when printing is called. When both the mod criterion and the printStates criterion are satisfied, the status test will be printed to the OutputManager with MsgType of StatusTestDetails.
| mod | (in) A positive number describes how often the output should be printed. On every call to checkStatus(), an internal counter is incremented. Printing may only occur when this counter is congruent to zero modulo mod. Default: 1 (attempt to print on every call to checkStatus()) |
| printStates | (in) A combination of TestStatus values for which the output may be printed. Default: Passed (attempt to print whenever checkStatus() will return Passed) |
Definition at line 63 of file AnasaziStatusTestOutput.hpp.
|
inlinevirtual |
Destructor.
Definition at line 71 of file AnasaziStatusTestOutput.hpp.
|
inlinevirtual |
Check and return status of underlying StatusTest.
This method calls checkStatus() on the StatusTest object passed in the constructor. If appropriate, the method will follow this call with a call to print() on the underlying object, using the OutputManager passed via the constructor with verbosity level StatusTestDetails.
The internal counter will be incremented during this call, but only after performing the tests to decide whether or not to print the underlying StatusTest. This way, the very first call to checkStatus() following initialization or reset() will enable the underlying StatusTest to be printed, regardless of the mod parameter, as the current number of calls will be zero.
If the specified Teuchos::RCP for the child class is Teuchos::null, then calling checkStatus() will result in a StatusTestError exception being thrown.
Implements Anasazi::StatusTest< ScalarType, MV, OP >.
Definition at line 93 of file AnasaziStatusTestOutput.hpp.
|
inlinevirtual |
Return the result of the most recent checkStatus call, or undefined if it has not been run.
Implements Anasazi::StatusTest< ScalarType, MV, OP >.
Definition at line 112 of file AnasaziStatusTestOutput.hpp.
|
inlinevirtual |
Get the indices for the vectors that passed the test.
Implements Anasazi::StatusTest< ScalarType, MV, OP >.
Definition at line 117 of file AnasaziStatusTestOutput.hpp.
|
inlinevirtual |
Get the number of vectors that passed the test.
Implements Anasazi::StatusTest< ScalarType, MV, OP >.
Definition at line 122 of file AnasaziStatusTestOutput.hpp.
|
inline |
Set child test.
Definition at line 136 of file AnasaziStatusTestOutput.hpp.
|
inline |
Get child test.
Definition at line 142 of file AnasaziStatusTestOutput.hpp.
|
inlinevirtual |
Informs the status test that it should reset its internal configuration to the uninitialized state.
This resets the cached state to an Undefined state and calls reset() on the underlying test. It also resets the counter for the number of calls to checkStatus().
Implements Anasazi::StatusTest< ScalarType, MV, OP >.
Definition at line 156 of file AnasaziStatusTestOutput.hpp.
|
inlinevirtual |
Clears the results of the last status test. This resets the cached state to an Undefined state and calls clearStatus() on the underlying test.
Implements Anasazi::StatusTest< ScalarType, MV, OP >.
Definition at line 166 of file AnasaziStatusTestOutput.hpp.
|
inlinevirtual |
Output formatted description of stopping test to output stream.
Implements Anasazi::StatusTest< ScalarType, MV, OP >.
Definition at line 179 of file AnasaziStatusTestOutput.hpp.
1.8.5