Public Member Functions | |
def | __init__ |
def | checkStatus |
def | getStatus |
def | whichVecs |
def | howMany |
def | setMaxIters |
def | getMaxIters |
def | setNegate |
def | getNegate |
def | reset |
def | clearStatus |
def | __init__ |
def | checkStatus |
def | getStatus |
def | whichVecs |
def | howMany |
def | setMaxIters |
def | getMaxIters |
def | setNegate |
def | getNegate |
def | reset |
def | clearStatus |
Public Attributes | |
this |
A status test for testing the number of iterations. 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. C++ includes: AnasaziStatusTestMaxIters.hpp
def PyTrilinos::Anasazi::StatusTestMaxItersEpetra::__init__ | ( | self, | ||
args | ||||
) |
__init__(self, int maxIter, bool negate = False) -> StatusTestMaxItersEpetra Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::StatusTestMaxIters(int maxIter, bool negate=false) Constructor.
def PyTrilinos::Anasazi::StatusTestMaxItersEpetra::__init__ | ( | self, | ||
args | ||||
) |
__init__(self, int maxIter, bool negate = False) -> StatusTestMaxItersEpetra Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::StatusTestMaxIters(int maxIter, bool negate=false) Constructor.
def PyTrilinos::Anasazi::StatusTestMaxItersEpetra::checkStatus | ( | self, | ||
args | ||||
) |
checkStatus(self, EigensolverEpetra solver) -> TestStatus TestStatus Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::checkStatus(Eigensolver< ScalarType, MV, OP > *solver) Check status as defined by test. TestStatus indicating whether the test passed or failed.
Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.
def PyTrilinos::Anasazi::StatusTestMaxItersEpetra::checkStatus | ( | self, | ||
args | ||||
) |
checkStatus(self, EigensolverEpetra solver) -> TestStatus TestStatus Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::checkStatus(Eigensolver< ScalarType, MV, OP > *solver) Check status as defined by test. TestStatus indicating whether the test passed or failed.
Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.
def PyTrilinos::Anasazi::StatusTestMaxItersEpetra::clearStatus | ( | self, | ||
args | ||||
) |
clearStatus(self) void Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::clearStatus() 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.
Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.
def PyTrilinos::Anasazi::StatusTestMaxItersEpetra::clearStatus | ( | self, | ||
args | ||||
) |
clearStatus(self) void Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::clearStatus() 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.
Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.
def PyTrilinos::Anasazi::StatusTestMaxItersEpetra::getMaxIters | ( | self, | ||
args | ||||
) |
getMaxIters(self) -> int int Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::getMaxIters() Get the maximum number of iterations.
def PyTrilinos::Anasazi::StatusTestMaxItersEpetra::getMaxIters | ( | self, | ||
args | ||||
) |
getMaxIters(self) -> int int Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::getMaxIters() Get the maximum number of iterations.
def PyTrilinos::Anasazi::StatusTestMaxItersEpetra::getNegate | ( | self, | ||
args | ||||
) |
getNegate(self) -> bool bool Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::getNegate() const Get the negation policy for the status test.
def PyTrilinos::Anasazi::StatusTestMaxItersEpetra::getNegate | ( | self, | ||
args | ||||
) |
getNegate(self) -> bool bool Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::getNegate() const Get the negation policy for the status test.
def PyTrilinos::Anasazi::StatusTestMaxItersEpetra::getStatus | ( | self, | ||
args | ||||
) |
getStatus(self) -> TestStatus TestStatus Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::getStatus() const Return the result of the most recent checkStatus call.
Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.
def PyTrilinos::Anasazi::StatusTestMaxItersEpetra::getStatus | ( | self, | ||
args | ||||
) |
getStatus(self) -> TestStatus TestStatus Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::getStatus() const Return the result of the most recent checkStatus call.
Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.
def PyTrilinos::Anasazi::StatusTestMaxItersEpetra::howMany | ( | self, | ||
args | ||||
) |
howMany(self) -> int int Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::howMany() const Get the number of vectors that passed the test.
Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.
def PyTrilinos::Anasazi::StatusTestMaxItersEpetra::howMany | ( | self, | ||
args | ||||
) |
howMany(self) -> int int Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::howMany() const Get the number of vectors that passed the test.
Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.
def PyTrilinos::Anasazi::StatusTestMaxItersEpetra::reset | ( | self, | ||
args | ||||
) |
reset(self) void Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::reset() 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.
Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.
def PyTrilinos::Anasazi::StatusTestMaxItersEpetra::reset | ( | self, | ||
args | ||||
) |
reset(self) void Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::reset() 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.
Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.
def PyTrilinos::Anasazi::StatusTestMaxItersEpetra::setMaxIters | ( | self, | ||
args | ||||
) |
setMaxIters(self, int maxIters) void Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::setMaxIters(int maxIters) Set the maximum number of iterations. This also resets the test status to Undefined.
def PyTrilinos::Anasazi::StatusTestMaxItersEpetra::setMaxIters | ( | self, | ||
args | ||||
) |
setMaxIters(self, int maxIters) void Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::setMaxIters(int maxIters) Set the maximum number of iterations. This also resets the test status to Undefined.
def PyTrilinos::Anasazi::StatusTestMaxItersEpetra::setNegate | ( | self, | ||
args | ||||
) |
setNegate(self, bool negate) void Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::setNegate(bool negate) Set the negation policy for the status test. This also reset the test status to Undefined.
def PyTrilinos::Anasazi::StatusTestMaxItersEpetra::setNegate | ( | self, | ||
args | ||||
) |
setNegate(self, bool negate) void Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::setNegate(bool negate) Set the negation policy for the status test. This also reset the test status to Undefined.
def PyTrilinos::Anasazi::StatusTestMaxItersEpetra::whichVecs | ( | self, | ||
args | ||||
) |
whichVecs(self) -> VectorInt std::vector<int> Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::whichVecs() const Get the indices for the vectors that passed the test.
Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.
def PyTrilinos::Anasazi::StatusTestMaxItersEpetra::whichVecs | ( | self, | ||
args | ||||
) |
whichVecs(self) -> VectorInt std::vector<int> Anasazi::StatusTestMaxIters< ScalarType, MV, OP >::whichVecs() const Get the indices for the vectors that passed the test.
Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.