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 
57 #include "ROL_Types.hpp"
58 
59 namespace ROL {
60 namespace TypeB {
61 
80 };
81 
82 inline std::string EAlgorithmBToString(EAlgorithmB alg) {
83  std::string retString;
84  switch(alg) {
85  case ALGORITHM_B_LINESEARCH: retString = "Line Search"; break;
86  case ALGORITHM_B_TRUSTREGION: retString = "Trust Region"; break;
87  case ALGORITHM_B_MOREAUYOSIDA: retString = "Moreau-Yosida"; break;
88  case ALGORITHM_B_PRIMALDUALACTIVESET: retString = "Primal Dual Active Set"; break;
89  case ALGORITHM_B_INTERIORPOINT: retString = "Interior Point"; break;
90  case ALGORITHM_B_SPECTRALGRADIENT: retString = "Spectral Gradient"; break;
91  case ALGORITHM_B_LAST: retString = "Last Type (Dummy)"; break;
92  default: retString = "INVALID EAlgorithmB";
93  }
94  return retString;
95 }
96 
103  return( (alg == ALGORITHM_B_LINESEARCH) ||
104  (alg == ALGORITHM_B_TRUSTREGION) ||
105  (alg == ALGORITHM_B_MOREAUYOSIDA) ||
107  (alg == ALGORITHM_B_INTERIORPOINT) ||
108  (alg == ALGORITHM_B_SPECTRALGRADIENT) ||
109  (alg == ALGORITHM_B_LAST)
110  );
111 }
112 
114  return type = static_cast<EAlgorithmB>(type+1);
115 }
116 
117 inline EAlgorithmB operator++(EAlgorithmB &type, int) {
118  EAlgorithmB oldval = type;
119  ++type;
120  return oldval;
121 }
122 
124  return type = static_cast<EAlgorithmB>(type-1);
125 }
126 
127 inline EAlgorithmB operator--(EAlgorithmB &type, int) {
128  EAlgorithmB oldval = type;
129  --type;
130  return oldval;
131 }
132 
133 inline EAlgorithmB StringToEAlgorithmB(std::string s) {
134  s = removeStringFormat(s);
135  for ( EAlgorithmB alg = ALGORITHM_B_LINESEARCH; alg < ALGORITHM_B_LAST; alg++ ) {
136  if ( !s.compare(removeStringFormat(EAlgorithmBToString(alg))) ) {
137  return alg;
138  }
139  }
141 }
142 
143 template<typename Real>
144 inline Ptr<Algorithm<Real>> AlgorithmFactory(ParameterList &parlist) {
145  EAlgorithmB ealg = StringToEAlgorithmB(parlist.sublist("Step").get("Type","Trust Region"));
146  std::string desc
147  = parlist.sublist("Step").sublist("Line Search").sublist("Descent Method").get("Type","Newton-Krylov");
148  std::string trmod
149  = parlist.sublist("Step").sublist("Trust Region").get("Subproblem Model","Lin-More");
150  switch(ealg) {
152  if (desc=="Newton-Krylov" || desc=="Newton")
153  return makePtr<NewtonKrylovAlgorithm<Real>>(parlist);
154  else if (desc=="Quasi-Newton Method")
155  return makePtr<QuasiNewtonAlgorithm<Real>>(parlist);
156  else
157  return makePtr<GradientAlgorithm<Real>>(parlist);
159  if (trmod=="Kelley-Sachs")
160  return makePtr<KelleySachsAlgorithm<Real>>(parlist);
161  else if (trmod=="SPG")
162  return makePtr<TrustRegionSPGAlgorithm<Real>>(parlist);
163  else
164  return makePtr<LinMoreAlgorithm<Real>>(parlist);
165  case ALGORITHM_B_MOREAUYOSIDA: return makePtr<MoreauYosidaAlgorithm<Real>>(parlist);
166  case ALGORITHM_B_PRIMALDUALACTIVESET: return makePtr<PrimalDualActiveSetAlgorithm<Real>>(parlist);
167  case ALGORITHM_B_INTERIORPOINT: return makePtr<InteriorPointAlgorithm<Real>>(parlist);
168  case ALGORITHM_B_SPECTRALGRADIENT: return makePtr<SpectralGradientAlgorithm<Real>>(parlist);
169  default: return nullPtr;
170  }
171 }
172 } // namespace TypeB
173 } // namespace ROL
174 
175 #endif
EAlgorithmB & operator--(EAlgorithmB &type)
EAlgorithmB
Enumeration of bound constrained algorithm types.
Contains definitions of custom data types in ROL.
std::string removeStringFormat(std::string s)
Definition: ROL_Types.hpp:247
std::string EAlgorithmBToString(EAlgorithmB alg)
EAlgorithmB StringToEAlgorithmB(std::string s)
EAlgorithmB & operator++(EAlgorithmB &type)
Ptr< Algorithm< Real > > AlgorithmFactory(ParameterList &parlist)
int isValidAlgorithmB(EAlgorithmB alg)
Verifies validity of a AlgorithmB enum.