#include <AnasaziStatusTestMaxIters.hpp>
Inheritance diagram for Anasazi::StatusTestMaxIters< ScalarType, MV, OP >:
Public Member Functions | |
Constructors/destructors | |
| StatusTestMaxIters (int maxIter, bool negate=false) | |
| Constructor. | |
| virtual | ~StatusTestMaxIters () |
| Destructor. | |
Status methods | |
| TestStatus | checkStatus (Eigensolver< ScalarType, MV, OP > *solver) |
| Check status as defined by test. | |
| 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 | setMaxIters (int maxIters) |
| Set the maximum number of iterations. | |
| int | getMaxIters () |
| Get the maximum number of iterations. | |
| void | setNegate (bool negate) |
| Set the negation policy for the status test. | |
| bool | getNegate () const |
| Get the negation policy for the status test. | |
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. | |
Anasazi::StatusTestMaxIters will test true when an eigensolver has reached some number of iterations. Specifically,
{ Passed, if solver->getNumIters() >= maxIter
status(solver) = {
{ Failed, if solver->getNumIters() < maxIter
where maxIter is the parameter given to the status tester.This status test also supports negation, so that it negates the need for a StatusTestMinIters status tester. In this way, all tests on the range of iterations can be constructed through the appropriate use of StatusTestMaxIters and StatusTestCombo.
| Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::StatusTestMaxIters | ( | int | maxIter, | |
| bool | negate = false | |||
| ) | [inline] |
Constructor.
| virtual Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::~StatusTestMaxIters | ( | ) | [inline, virtual] |
Destructor.
| TestStatus Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::checkStatus | ( | Eigensolver< ScalarType, MV, OP > * | solver | ) | [inline, virtual] |
Check status as defined by test.
Implements Anasazi::StatusTest< ScalarType, MV, OP >.
| TestStatus Anasazi::StatusTestMaxIters< 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::StatusTestMaxIters< ScalarType, MV, OP >::whichVecs | ( | ) | const [inline, virtual] |
Get the indices for the vectors that passed the test.
Implements Anasazi::StatusTest< ScalarType, MV, OP >.
| int Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::howMany | ( | ) | const [inline, virtual] |
Get the number of vectors that passed the test.
Implements Anasazi::StatusTest< ScalarType, MV, OP >.
| void Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::setMaxIters | ( | int | maxIters | ) | [inline] |
| int Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::getMaxIters | ( | ) | [inline] |
Get the maximum number of iterations.
| void Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::setNegate | ( | bool | negate | ) | [inline] |
| bool Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::getNegate | ( | ) | const [inline] |
Get the negation policy for the status test.
| void Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::reset | ( | ) | [inline, virtual] |
Informs the status test that it should reset its internal configuration to the uninitialized state.
The StatusTestMaxIters class has no internal state, so this call is equivalent to calling clearStatus(). 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.
Implements Anasazi::StatusTest< ScalarType, MV, OP >.
| void Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::clearStatus | ( | ) | [inline, 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.
Implements Anasazi::StatusTest< ScalarType, MV, OP >.
| std::ostream& Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::print | ( | std::ostream & | os, | |
| int | indent = 0 | |||
| ) | const [inline, virtual] |
Output formatted description of stopping test to output stream.
Implements Anasazi::StatusTest< ScalarType, MV, OP >.
1.4.7