/usr/include/trilinos/ROL_StatusTest.hpp is in libtrilinos-rol-dev 12.12.1-5.
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 | // @HEADER
// ************************************************************************
//
// Rapid Optimization Library (ROL) Package
// Copyright (2014) 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.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact lead developers:
// Drew Kouri (dpkouri@sandia.gov) and
// Denis Ridzal (dridzal@sandia.gov)
//
// ************************************************************************
// @HEADER
#ifndef ROL_STATUSTEST_H
#define ROL_STATUSTEST_H
#include "ROL_Types.hpp"
/** \class ROL::StatusTest
\brief Provides an interface to check status of optimization algorithms.
*/
namespace ROL {
template <class Real>
class StatusTest {
private:
Real gtol_;
Real stol_;
int max_iter_;
public:
virtual ~StatusTest() {}
StatusTest( Teuchos::ParameterList &parlist ) {
Real em6(1e-6);
gtol_ = parlist.sublist("Status Test").get("Gradient Tolerance", em6);
stol_ = parlist.sublist("Status Test").get("Step Tolerance", em6*gtol_);
max_iter_ = parlist.sublist("Status Test").get("Iteration Limit", 100);
}
StatusTest( Real gtol = 1.e-6, Real stol = 1.e-12, int max_iter = 100 ) :
gtol_(gtol), stol_(stol), max_iter_(max_iter) {}
/** \brief Check algorithm status.
*/
virtual bool check( AlgorithmState<Real> &state ) {
if ( (state.gnorm > gtol_) &&
(state.snorm > stol_) &&
(state.iter < max_iter_) ) {
return true;
}
else {
return false;
}
}
}; // class StatusTest
} // namespace ROL
#endif
|