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 
54 namespace ROL {
55 
56 
57 template <class Real>
58 class StatusTest {
59 private:
60 
61  Real gtol_;
62  Real stol_;
63  int max_iter_;
64 
65 public:
66 
67  virtual ~StatusTest() {}
68 
69  StatusTest( Real gtol = 1.e-6, Real stol = 1.e-12, int max_iter = 100 ) :
70  gtol_(gtol), stol_(stol), max_iter_(max_iter) {}
71 
74  virtual bool check( AlgorithmState<Real> &state ) {
75  if ( (state.gnorm > this->gtol_) &&
76  (state.snorm > this->stol_) &&
77  (state.iter < this->max_iter_) ) {
78  return true;
79  }
80  else {
81  return false;
82  }
83  }
84 
85 }; // class StatusTest
86 
87 
88 template <class Real>
89 class StatusTestSQP : public StatusTest<Real> {
90 private:
91 
92  Real gtol_;
93  Real ctol_;
94  Real stol_;
95  int max_iter_;
96 
97 public:
98 
99  virtual ~StatusTestSQP() {}
100 
101  StatusTestSQP( Real gtol = 1e-6, Real ctol = 1e-6, Real stol = 1e-12, int max_iter = 100 ) :
102  gtol_(gtol), ctol_(ctol), stol_(stol), max_iter_(max_iter) {}
103 
106  virtual bool check( AlgorithmState<Real> &state ) {
107  if ( ((state.gnorm > this->gtol_) || (state.cnorm > this->ctol_)) &&
108  (state.snorm > this->stol_) &&
109  (state.iter < this->max_iter_) ) {
110  return true;
111  }
112  else {
113  return false;
114  }
115  }
116 
117 }; // class StatusTestSQP
118 
119 } // namespace ROL
120 
121 #endif
virtual bool check(AlgorithmState< Real > &state)
Check algorithm status.
Contains definitions of custom data types in ROL.
virtual bool check(AlgorithmState< Real > &state)
Check algorithm status.
StatusTest(Real gtol=1.e-6, Real stol=1.e-12, int max_iter=100)
State for algorithm class. Will be used for restarts.
Definition: ROL_Types.hpp:76
virtual ~StatusTest()
Provides an interface to check status of optimization algorithms.
StatusTestSQP(Real gtol=1e-6, Real ctol=1e-6, Real stol=1e-12, int max_iter=100)