Anasazi
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
src
AnasaziStatusTest.hpp
Go to the documentation of this file.
1
// @HEADER
2
// *****************************************************************************
3
// Anasazi: Block Eigensolvers Package
4
//
5
// Copyright 2004 NTESS and the Anasazi contributors.
6
// SPDX-License-Identifier: BSD-3-Clause
7
// *****************************************************************************
8
// @HEADER
9
//
10
11
#ifndef ANASAZI_STATUS_TEST_HPP
12
#define ANASAZI_STATUS_TEST_HPP
13
16
17
#include "
AnasaziTypes.hpp
"
18
#include "
AnasaziStatusTestDecl.hpp
"
19
#include "
AnasaziEigensolverDecl.hpp
"
20
21
namespace
Anasazi
{
22
24
25
28
class
StatusTestError :
public
AnasaziError
29
{
public
: StatusTestError(
const
std::string& what_arg) : AnasaziError(what_arg) {}};
30
32
41
42
template
<
class
ScalarType,
class
MV,
class
OP>
43
class
StatusTest
{
44
45
public
:
47
48
50
StatusTest
() {};
51
53
virtual
~StatusTest
() {};
55
57
58
62
virtual
TestStatus
checkStatus
(
Eigensolver<ScalarType,MV,OP>
* solver ) = 0;
63
65
virtual
TestStatus
getStatus
()
const
= 0;
66
68
virtual
std::vector<int>
whichVecs
()
const
= 0;
69
71
virtual
int
howMany
()
const
= 0;
72
74
76
77
83
virtual
void
reset
() = 0;
84
86
91
virtual
void
clearStatus
() = 0;
92
94
96
97
99
virtual
std::ostream&
print
(std::ostream& os,
int
indent = 0)
const
= 0;
100
102
103
};
104
105
}
// end of Anasazi namespace
106
107
#endif
/* ANASAZI_STATUS_TEST_HPP */
AnasaziEigensolverDecl.hpp
Forward declaration of the virtual base class Anasazi::Eigensolver.
AnasaziStatusTestDecl.hpp
Forward declaration of pure virtual base class Anasazi::StatusTest.
AnasaziTypes.hpp
Types and exceptions used within Anasazi solvers and interfaces.
Anasazi::Eigensolver
The Eigensolver is a templated virtual base class that defines the basic interface that any eigensolv...
Definition
AnasaziEigensolver.hpp:35
Anasazi::StatusTest::whichVecs
virtual std::vector< int > whichVecs() const =0
Get the indices for the vectors that passed the test.
Anasazi::StatusTest::howMany
virtual int howMany() const =0
Get the number of vectors that passed the test.
Anasazi::StatusTest::reset
virtual void reset()=0
Informs the status test that it should reset its internal configuration to the uninitialized state.
Anasazi::StatusTest::checkStatus
virtual TestStatus checkStatus(Eigensolver< ScalarType, MV, OP > *solver)=0
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:50
Anasazi::StatusTest::~StatusTest
virtual ~StatusTest()
Destructor.
Definition
AnasaziStatusTest.hpp:53
Anasazi::StatusTest::clearStatus
virtual void clearStatus()=0
Clears the results of the last status test.
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
Namespace Anasazi contains the classes, structs, enums and utilities used by the Anasazi package.
Anasazi::TestStatus
TestStatus
Enumerated type used to pass back information from a StatusTest.
Definition
AnasaziTypes.hpp:110
Generated by
1.17.0