ROL
ROL_ConstraintStatusTest.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_CONSTRAINTSTATUSTEST_H
45#define ROL_CONSTRAINTSTATUSTEST_H
46
47#include "ROL_StatusTest.hpp"
48
55namespace ROL {
56
57template <class Real>
58class ConstraintStatusTest : public StatusTest<Real> {
59private:
60
61 Real gtol_;
62 Real ctol_;
63 Real stol_;
65
66public:
67
69
70 ConstraintStatusTest( ROL::ParameterList &parlist ) {
71 Real em6(1e-6);
72 gtol_ = parlist.sublist("Status Test").get("Gradient Tolerance", em6);
73 ctol_ = parlist.sublist("Status Test").get("Constraint Tolerance", em6);
74 stol_ = parlist.sublist("Status Test").get("Step Tolerance", em6*gtol_);
75 max_iter_ = parlist.sublist("Status Test").get("Iteration Limit", 100);
76 }
77
78 ConstraintStatusTest( Real gtol = 1e-6, Real ctol = 1e-6, Real stol = 1e-12, int max_iter = 100 ) :
79 gtol_(gtol), ctol_(ctol), stol_(stol), max_iter_(max_iter) {}
80
83 virtual bool check( AlgorithmState<Real> &state ) {
84 if ( ((state.gnorm > gtol_) || (state.cnorm > ctol_)) &&
85 (state.snorm > stol_) &&
86 (state.iter < max_iter_) ) {
87 return true;
88 }
89 else {
90 state.statusFlag = ((state.gnorm <= gtol_) && (state.cnorm <= ctol_) ? EXITSTATUS_CONVERGED
91 : state.snorm <= stol_ ? EXITSTATUS_STEPTOL
94 return false;
95 }
96 }
97
98}; // class ConstraintStatusTest
99
100} // namespace ROL
101
102#endif
Provides an interface to check status of optimization algorithms for problems with equality constrain...
ConstraintStatusTest(ROL::ParameterList &parlist)
ConstraintStatusTest(Real gtol=1e-6, Real ctol=1e-6, Real stol=1e-12, int max_iter=100)
virtual bool check(AlgorithmState< Real > &state)
Check algorithm status.
Provides an interface to check status of optimization algorithms.
@ EXITSTATUS_STEPTOL
Definition: ROL_Types.hpp:120
@ EXITSTATUS_MAXITER
Definition: ROL_Types.hpp:119
@ EXITSTATUS_CONVERGED
Definition: ROL_Types.hpp:118
@ 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