ROL
ROL_StatusTest.hpp
Go to the documentation of this file.
1// @HEADER
2// ************************************************************************
3//
4// Rapid Optimization Library (ROL) Package
5// Copyright (2014) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
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 lead developers:
38// Drew Kouri (dpkouri@sandia.gov) and
39// Denis Ridzal (dridzal@sandia.gov)
40//
41// ************************************************************************
42// @HEADER
43
44#ifndef ROL_STATUSTEST_H
45#define ROL_STATUSTEST_H
46
47#include "ROL_Types.hpp"
48#include "ROL_ParameterList.hpp"
49
55namespace ROL {
56
57template <class Real>
59private:
60
61 Real gtol_;
62 Real stol_;
65
66public:
67
68 virtual ~StatusTest() {}
69
70 StatusTest( ROL::ParameterList &parlist ) {
71 Real em6(1e-6);
72 gtol_ = parlist.sublist("Status Test").get("Gradient Tolerance", em6);
73 stol_ = parlist.sublist("Status Test").get("Step Tolerance", em6*gtol_);
74 max_iter_ = parlist.sublist("Status Test").get("Iteration Limit", 100);
75 use_rel_ = parlist.sublist("Status Test").get("Use Relative Tolerances", false);
76 }
77
78 StatusTest( Real gtol = 1.e-6, Real stol = 1.e-12, int max_iter = 100, bool use_rel = false ) :
79 gtol_(gtol), stol_(stol), max_iter_(max_iter), use_rel_(use_rel) {}
80
83 virtual bool check( AlgorithmState<Real> &state ) {
84 if (state.iter==0 && use_rel_) {
85 gtol_ *= state.gnorm;
86 stol_ *= state.gnorm;
87 }
88 if ( (state.gnorm > gtol_) &&
89 (state.snorm > stol_) &&
90 (state.iter < max_iter_) ) {
91 return true;
92 }
93 else {
94 state.statusFlag = (state.gnorm <= gtol_ ? EXITSTATUS_CONVERGED
95 : state.snorm <= stol_ ? EXITSTATUS_STEPTOL
97 : std::isnan(state.gnorm)||std::isnan(state.snorm) ? EXITSTATUS_NAN
99 return false;
100 }
101 }
102
103}; // class StatusTest
104
105} // namespace ROL
106
107#endif
Contains definitions of custom data types in ROL.
Provides an interface to check status of optimization algorithms.
StatusTest(Real gtol=1.e-6, Real stol=1.e-12, int max_iter=100, bool use_rel=false)
virtual bool check(AlgorithmState< Real > &state)
Check algorithm status.
virtual ~StatusTest()
StatusTest(ROL::ParameterList &parlist)
@ EXITSTATUS_STEPTOL
Definition: ROL_Types.hpp:120
@ EXITSTATUS_MAXITER
Definition: ROL_Types.hpp:119
@ EXITSTATUS_CONVERGED
Definition: ROL_Types.hpp:118
@ EXITSTATUS_NAN
Definition: ROL_Types.hpp:121
@ EXITSTATUS_LAST
Definition: ROL_Types.hpp:123
State for algorithm class. Will be used for restarts.
Definition: ROL_Types.hpp:143
EExitStatus statusFlag
Definition: ROL_Types.hpp:160