ROL
ROL_CombinedStatusTest.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_COMBINEDSTATUSTEST_H
45#define ROL_COMBINEDSTATUSTEST_H
46
47#include "ROL_StatusTest.hpp"
48
54namespace ROL {
55
56template<typename Real>
57class CombinedStatusTest : public StatusTest<Real> {
58private:
59 std::vector<Ptr<StatusTest<Real>>> status_;
60
61public:
63 status_.clear();
64 }
65
66 void reset(void) {
67 status_.clear();
68 }
69
70 void add(const Ptr<StatusTest<Real>> &status) {
71 status_.push_back(status);
72 }
73
74 bool check( AlgorithmState<Real> &state ) {
75 ROL_TEST_FOR_EXCEPTION(status_.empty(),std::logic_error,
76 ">>> ROL::CombinedStatusTest::check : No status test has been added!");
77
78 bool flag = true;
79 for (const auto & status : status_) {
80 flag = status->check(state);
81 if (!flag) break;
82 }
83
84 // true = "continue iteration"
85 // false = "stop iteration"
86 return flag;
87 }
88
89}; // class CombinedStatusTest
90
91} // namespace ROL
92
93#endif
Provides an interface to check two status tests of optimization algorithms.
bool check(AlgorithmState< Real > &state)
Check algorithm status.
std::vector< Ptr< StatusTest< Real > > > status_
void add(const Ptr< StatusTest< Real > > &status)
Provides an interface to check status of optimization algorithms.
State for algorithm class. Will be used for restarts.