ROL
ROL_TypeB_AlgorithmFactory.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_TYPEB_ALGORITHMFACTORY_H
45#define ROL_TYPEB_ALGORITHMFACTORY_H
46
59#include "ROL_Types.hpp"
60
61namespace ROL {
62namespace TypeB {
63
83
84inline std::string EAlgorithmBToString(EAlgorithmB alg) {
85 std::string retString;
86 switch(alg) {
87 case ALGORITHM_B_LINESEARCH: retString = "Line Search"; break;
88 case ALGORITHM_B_TRUSTREGION: retString = "Trust Region"; break;
89 case ALGORITHM_B_MOREAUYOSIDA: retString = "Moreau-Yosida"; break;
90 case ALGORITHM_B_PRIMALDUALACTIVESET: retString = "Primal Dual Active Set"; break;
91 case ALGORITHM_B_INTERIORPOINT: retString = "Interior Point"; break;
92 case ALGORITHM_B_SPECTRALGRADIENT: retString = "Spectral Gradient"; break;
93 case ALGORITHM_B_LAST: retString = "Last Type (Dummy)"; break;
94 default: retString = "INVALID EAlgorithmB";
95 }
96 return retString;
97}
98
105 return( (alg == ALGORITHM_B_LINESEARCH) ||
106 (alg == ALGORITHM_B_TRUSTREGION) ||
107 (alg == ALGORITHM_B_MOREAUYOSIDA) ||
109 (alg == ALGORITHM_B_INTERIORPOINT) ||
111 (alg == ALGORITHM_B_LAST)
112 );
113}
114
116 return type = static_cast<EAlgorithmB>(type+1);
117}
118
120 EAlgorithmB oldval = type;
121 ++type;
122 return oldval;
123}
124
126 return type = static_cast<EAlgorithmB>(type-1);
127}
128
130 EAlgorithmB oldval = type;
131 --type;
132 return oldval;
133}
134
135inline EAlgorithmB StringToEAlgorithmB(std::string s) {
136 s = removeStringFormat(s);
137 for ( EAlgorithmB alg = ALGORITHM_B_LINESEARCH; alg < ALGORITHM_B_LAST; alg++ ) {
138 if ( !s.compare(removeStringFormat(EAlgorithmBToString(alg))) ) {
139 return alg;
140 }
141 }
143}
144
145template<typename Real>
146inline Ptr<Algorithm<Real>> AlgorithmFactory(ParameterList &parlist) {
147 EAlgorithmB ealg = StringToEAlgorithmB(parlist.sublist("Step").get("Type","Trust Region"));
148 switch(ealg) {
150 {
151 std::string desc
152 = parlist.sublist("Step").sublist("Line Search").sublist("Descent Method").get("Type","Newton-Krylov");
153 if (desc=="Newton-Krylov" || desc=="Newton")
154 return makePtr<NewtonKrylovAlgorithm<Real>>(parlist);
155 else if (desc=="Quasi-Newton Method") {
156 std::string method
157 = parlist.sublist("Step").sublist("Line Search").sublist("Quasi-Newton").get("Method","L-Secant-B");
158 if (method == "L-Secant-B")
159 return makePtr<LSecantBAlgorithm<Real>>(parlist); // Similar to L-BFGS-B
160 else
161 return makePtr<QuasiNewtonAlgorithm<Real>>(parlist); // PQN
162 }
163 else {
164 return makePtr<GradientAlgorithm<Real>>(parlist);
165 }
166 }
168 {
169 std::string trmod
170 = parlist.sublist("Step").sublist("Trust Region").get("Subproblem Model","Lin-More");
171 if (trmod=="Kelley-Sachs")
172 return makePtr<KelleySachsAlgorithm<Real>>(parlist);
173 else if (trmod=="SPG")
174 return makePtr<TrustRegionSPGAlgorithm<Real>>(parlist);
175 else if (trmod=="Coleman-Li")
176 return makePtr<ColemanLiAlgorithm<Real>>(parlist);
177 else
178 return makePtr<LinMoreAlgorithm<Real>>(parlist);
179 }
180 case ALGORITHM_B_MOREAUYOSIDA: return makePtr<MoreauYosidaAlgorithm<Real>>(parlist);
181 case ALGORITHM_B_PRIMALDUALACTIVESET: return makePtr<PrimalDualActiveSetAlgorithm<Real>>(parlist);
182 case ALGORITHM_B_INTERIORPOINT: return makePtr<InteriorPointAlgorithm<Real>>(parlist);
183 case ALGORITHM_B_SPECTRALGRADIENT: return makePtr<SpectralGradientAlgorithm<Real>>(parlist);
184 default: return nullPtr;
185 }
186}
187} // namespace TypeB
188} // namespace ROL
189
190#endif
Contains definitions of custom data types in ROL.
EAlgorithmB StringToEAlgorithmB(std::string s)
EAlgorithmB & operator--(EAlgorithmB &type)
Ptr< Algorithm< Real > > AlgorithmFactory(ParameterList &parlist)
EAlgorithmB & operator++(EAlgorithmB &type)
std::string EAlgorithmBToString(EAlgorithmB alg)
int isValidAlgorithmB(EAlgorithmB alg)
Verifies validity of a AlgorithmB enum.
std::string removeStringFormat(std::string s)