ROL
ROL_TrustRegion_U_Types.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
49#ifndef ROL_TRUSTREGION_U_TYPES_HPP
50#define ROL_TRUSTREGION_U_TYPES_HPP
51
52namespace ROL {
53
70 };
71
72 inline std::string ETrustRegionUToString(ETrustRegionU tr) {
73 std::string retString;
74 switch(tr) {
75 case TRUSTREGION_U_CAUCHYPOINT: retString = "Cauchy Point"; break;
76 case TRUSTREGION_U_TRUNCATEDCG: retString = "Truncated CG"; break;
77 case TRUSTREGION_U_SPG: retString = "SPG"; break;
78 case TRUSTREGION_U_DOGLEG: retString = "Dogleg"; break;
79 case TRUSTREGION_U_DOUBLEDOGLEG: retString = "Double Dogleg"; break;
80 case TRUSTREGION_U_LAST: retString = "Last Type (Dummy)"; break;
81 default: retString = "INVALID ETrustRegionU";
82 }
83 return retString;
84 }
85
92 return( (ls == TRUSTREGION_U_CAUCHYPOINT) ||
94 (ls == TRUSTREGION_U_SPG) ||
95 (ls == TRUSTREGION_U_DOGLEG) ||
97 );
98 }
99
101 return type = static_cast<ETrustRegionU>(type+1);
102 }
103
105 ETrustRegionU oldval = type;
106 ++type;
107 return oldval;
108 }
109
111 return type = static_cast<ETrustRegionU>(type-1);
112 }
113
115 ETrustRegionU oldval = type;
116 --type;
117 return oldval;
118 }
119
120 inline ETrustRegionU StringToETrustRegionU(std::string s) {
121 s = removeStringFormat(s);
123 if ( !s.compare(removeStringFormat(ETrustRegionUToString(tr))) ) {
124 return tr;
125 }
126 }
128 }
129} // ROL
130
131#endif
std::string removeStringFormat(std::string s)
Definition: ROL_Types.hpp:249
ETrustRegionU StringToETrustRegionU(std::string s)
EPolyProjAlgo & operator--(EPolyProjAlgo &type)
int isValidTrustRegionU(ETrustRegionU ls)
Verifies validity of a TrustRegionU enum.
EPolyProjAlgo & operator++(EPolyProjAlgo &type)
std::string ETrustRegionUToString(ETrustRegionU tr)