Anasazi  Version of the Day
AnasaziStatusTest.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Anasazi: Block Eigensolvers Package
5 // Copyright 2004 Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 //
42 
43 #ifndef ANASAZI_STATUS_TEST_HPP
44 #define ANASAZI_STATUS_TEST_HPP
45 
48 
49 #include "AnasaziTypes.hpp"
52 
53 namespace Anasazi {
54 
56 
57 
61  {public: StatusTestError(const std::string& what_arg) : AnasaziError(what_arg) {}};
62 
64 
73 
74 template <class ScalarType, class MV, class OP>
75 class StatusTest {
76 
77  public:
79 
80 
82  StatusTest() {};
83 
85  virtual ~StatusTest() {};
87 
89 
90 
95 
97  virtual TestStatus getStatus() const = 0;
98 
100  virtual std::vector<int> whichVecs() const = 0;
101 
103  virtual int howMany() const = 0;
104 
106 
108 
109 
115  virtual void reset() = 0;
116 
118 
123  virtual void clearStatus() = 0;
124 
126 
128 
129 
131  virtual std::ostream& print(std::ostream& os, int indent = 0) const = 0;
132 
134 
135 };
136 
137 } // end of Anasazi namespace
138 
139 #endif /* ANASAZI_STATUS_TEST_HPP */
Anasazi::StatusTest::whichVecs
virtual std::vector< int > whichVecs() const =0
Get the indices for the vectors that passed the test.
AnasaziTypes.hpp
Types and exceptions used within Anasazi solvers and interfaces.
AnasaziStatusTestDecl.hpp
Forward declaration of pure virtual base class Anasazi::StatusTest.
Anasazi::StatusTestError
Exception thrown to signal error in a status test during Anasazi::StatusTest::checkStatus().
Definition: AnasaziStatusTest.hpp:60
Anasazi::StatusTest::~StatusTest
virtual ~StatusTest()
Destructor.
Definition: AnasaziStatusTest.hpp:85
AnasaziEigensolverDecl.hpp
Forward declaration of the virtual base class Anasazi::Eigensolver.
Anasazi::StatusTest::print
virtual std::ostream & print(std::ostream &os, int indent=0) const =0
Output formatted description of stopping test to output stream.
Anasazi::StatusTest::StatusTest
StatusTest()
Constructor.
Definition: AnasaziStatusTest.hpp:82
Anasazi::StatusTest::howMany
virtual int howMany() const =0
Get the number of vectors that passed the test.
Anasazi::TestStatus
TestStatus
Enumerated type used to pass back information from a StatusTest.
Definition: AnasaziTypes.hpp:141
Anasazi::StatusTest::clearStatus
virtual void clearStatus()=0
Clears the results of the last status test.
Anasazi::Eigensolver
The Eigensolver is a templated virtual base class that defines the basic interface that any eigensolv...
Definition: AnasaziEigensolver.hpp:67
Anasazi::StatusTest::checkStatus
virtual TestStatus checkStatus(Eigensolver< ScalarType, MV, OP > *solver)=0
Anasazi
Namespace Anasazi contains the classes, structs, enums and utilities used by the Anasazi package.
Anasazi::StatusTest::reset
virtual void reset()=0
Informs the status test that it should reset its internal configuration to the uninitialized state.
Anasazi::StatusTest
Common interface of stopping criteria for Anasazi's solvers.
Definition: AnasaziStatusTest.hpp:75
Anasazi::StatusTest::getStatus
virtual TestStatus getStatus() const =0
Return the result of the most recent checkStatus call, or undefined if it has not been run.
Anasazi::AnasaziError
An exception class parent to all Anasazi exceptions.
Definition: AnasaziTypes.hpp:63