ROL
ROL_BundleStatusTest.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_BUNDLESTATUSTEST_H
45#define ROL_BUNDLESTATUSTEST_H
46
47#include "ROL_StatusTest.hpp"
48#include "ROL_Types.hpp"
49
50namespace ROL {
51
52template <class Real>
53class BundleStatusTest : public StatusTest<Real> {
54private:
55
56 Real tol_;
58
59public:
60
61 virtual ~BundleStatusTest() {}
62
63 BundleStatusTest( ROL::ParameterList &parlist ) {
64 Real em6(1e-6);
65 tol_ = parlist.sublist("Step").sublist("Bundle").get("Epsilon Solution Tolerance", em6);
66 max_iter_ = parlist.sublist("Status Test").get("Iteration Limit", 100);
67 }
68
69 BundleStatusTest( Real tol = 1.e-6, int max_iter = 100 ) :
70 tol_(tol), max_iter_(max_iter) {}
71
74 virtual bool check( AlgorithmState<Real> &state ) {
75 bool stat = false;
76 if ( (std::max(state.aggregateGradientNorm,state.aggregateModelError) > tol_)
77 && (state.iter < max_iter_)
78 && (state.flag == false) ) {
79 stat = true;
80 }
81 else {
84 : state.flag == true ? EXITSTATUS_CONVERGED
86 }
87 return stat;
88 }
89
90}; // class BundleStatusTest
91
92} // namespace ROL
93
94#endif
Contains definitions of custom data types in ROL.
BundleStatusTest(ROL::ParameterList &parlist)
BundleStatusTest(Real tol=1.e-6, int max_iter=100)
virtual bool check(AlgorithmState< Real > &state)
Check algorithm status.
Provides an interface to check status of optimization algorithms.
@ EXITSTATUS_MAXITER
@ EXITSTATUS_CONVERGED
@ EXITSTATUS_LAST
State for algorithm class. Will be used for restarts.
EExitStatus statusFlag