ROL
ROL_UpdateType.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_UPDATE_TYPE_HPP
45#define ROL_UPDATE_TYPE_HPP
46
47#include <cstdint>
48
49namespace ROL {
50
51enum class UpdateType : std::uint8_t {
52 Initial = 0, // Update has not been called before
53 Accept, // This is the new iterate, trial must be called before
54 Revert, // Revert to the previous iterate, trial must be called before
55 Trial, // This is a candidate for the next iterate
56 Temp // For temporary uses including finite difference computations
57};
58
59
60inline std::string UpdateTypeToString(const UpdateType& type) {
61 std::string retString;
62 switch(type) {
63 case UpdateType::Initial: retString = "Initial"; break;
64 case UpdateType::Accept: retString = "Accept"; break;
65 case UpdateType::Revert: retString = "Revert"; break;
66 case UpdateType::Trial: retString = "Trial"; break;
67 case UpdateType::Temp: retString = "Temp"; break;
68 }
69 return retString;
70}
71
72} // namespace ROL
73
74#endif
std::string UpdateTypeToString(const UpdateType &type)