/usr/include/trilinos/AnasaziStatusTest.hpp is in libtrilinos-anasazi-dev 12.10.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 | // @HEADER
// ***********************************************************************
//
// Anasazi: Block Eigensolvers Package
// Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER
//
#ifndef ANASAZI_STATUS_TEST_HPP
#define ANASAZI_STATUS_TEST_HPP
/// \file AnasaziStatusTest.hpp
/// \brief Declaration and definition of Anasazi::StatusTest.
#include "AnasaziTypes.hpp"
#include "AnasaziStatusTestDecl.hpp"
#include "AnasaziEigensolverDecl.hpp"
namespace Anasazi {
//! @name StatusTest Exceptions
//@{
/** \brief Exception thrown to signal error in a status test during Anasazi::StatusTest::checkStatus().
*/
class StatusTestError : public AnasaziError
{public: StatusTestError(const std::string& what_arg) : AnasaziError(what_arg) {}};
//@}
/// \example LOBPCGCustomStatusTest.cpp
/// \brief Use LOBPCG with Tpetra, with custom StatusTest.
///
/// This example shows how to define a custom StatusTest so that
/// Anasazi's solver LOBPCG converges correctly with spectrum folding.
/// Without a custom status test, Anasazi would compute the residual
/// as \f$R = A^2 X - X \Sigma^2\f$. The custom status test makes
/// Anasazi use the residual \f$R = A X - X \Sigma\f$ instead.
template <class ScalarType, class MV, class OP>
class StatusTest {
public:
//! @name Constructors/destructors
//@{
//! Constructor
StatusTest() {};
//! Destructor
virtual ~StatusTest() {};
//@}
//! @name Status methods
//@{
/*! Check status as defined by test.
\return TestStatus indicating whether the test passed or failed.
*/
virtual TestStatus checkStatus( Eigensolver<ScalarType,MV,OP>* solver ) = 0;
//! Return the result of the most recent checkStatus call, or undefined if it has not been run.
virtual TestStatus getStatus() const = 0;
//! Get the indices for the vectors that passed the test.
virtual std::vector<int> whichVecs() const = 0;
//! Get the number of vectors that passed the test.
virtual int howMany() const = 0;
//@}
//! @name Reset methods
//@{
//! Informs the status test that it should reset its internal configuration to the uninitialized state.
/*! This is necessary for the case when the status test is being reused by another solver or for another
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.
*/
virtual void reset() = 0;
//! 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.
*/
virtual void clearStatus() = 0;
//@}
//! @name Print methods
//@{
//! Output formatted description of stopping test to output stream.
virtual std::ostream& print(std::ostream& os, int indent = 0) const = 0;
//@}
};
} // end of Anasazi namespace
#endif /* ANASAZI_STATUS_TEST_HPP */
|