ROL
ROL_TypeE_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_TYPEE_ALGORITHMFACTORY_H
45#define ROL_TYPEE_ALGORITHMFACTORY_H
46
51#include "ROL_Types.hpp"
52
53namespace ROL {
54namespace TypeE {
55
65};
66
67inline std::string EAlgorithmEToString(EAlgorithmE alg) {
68 std::string retString;
69 switch(alg) {
70 case ALGORITHM_E_AUGMENTEDLAGRANGIAN: retString = "Augmented Lagrangian"; break;
71 case ALGORITHM_E_FLETCHER: retString = "Fletcher"; break;
72 case ALGORITHM_E_COMPOSITESTEP: retString = "Composite Step"; break;
73 case ALGORITHM_E_STABILIZEDLCL: retString = "Stabilized LCL"; break;
74 case ALGORITHM_E_LAST: retString = "Last Type (Dummy)"; break;
75 default: retString = "INVALID EAlgorithmE";
76 }
77 return retString;
78}
79
86 return( (alg == ALGORITHM_E_AUGMENTEDLAGRANGIAN) ||
87 (alg == ALGORITHM_E_FLETCHER) ||
90 (alg == ALGORITHM_E_LAST)
91 );
92}
93
95 return type = static_cast<EAlgorithmE>(type+1);
96}
97
99 EAlgorithmE oldval = type;
100 ++type;
101 return oldval;
102}
103
105 return type = static_cast<EAlgorithmE>(type-1);
106}
107
109 EAlgorithmE oldval = type;
110 --type;
111 return oldval;
112}
113
114inline EAlgorithmE StringToEAlgorithmE(std::string s) {
115 s = removeStringFormat(s);
117 if ( !s.compare(removeStringFormat(EAlgorithmEToString(alg))) ) {
118 return alg;
119 }
120 }
122}
123
124template<typename Real>
125inline Ptr<TypeE::Algorithm<Real>> AlgorithmFactory(ParameterList &parlist) {
126 EAlgorithmE ealg = StringToEAlgorithmE(parlist.sublist("Step").get("Type","Augmented Lagrangian"));
127 switch(ealg) {
128 case ALGORITHM_E_AUGMENTEDLAGRANGIAN: return makePtr<TypeE::AugmentedLagrangianAlgorithm<Real>>(parlist);
129 case ALGORITHM_E_FLETCHER: return makePtr<TypeE::FletcherAlgorithm<Real>>(parlist);
130 case ALGORITHM_E_COMPOSITESTEP: return makePtr<TypeE::CompositeStepAlgorithm<Real>>(parlist);
131 case ALGORITHM_E_STABILIZEDLCL: return makePtr<TypeE::StabilizedLCLAlgorithm<Real>>(parlist);
132 default: return nullPtr;
133 }
134}
135
136} // namespace TypeE
137} // namespace ROL
138
139#endif
Contains definitions of custom data types in ROL.
Ptr< TypeE::Algorithm< Real > > AlgorithmFactory(ParameterList &parlist)
EAlgorithmE & operator++(EAlgorithmE &type)
std::string EAlgorithmEToString(EAlgorithmE alg)
int isValidAlgorithmE(EAlgorithmE alg)
Verifies validity of a AlgorithmE enum.
EAlgorithmE & operator--(EAlgorithmE &type)
EAlgorithmE StringToEAlgorithmE(std::string s)
std::string removeStringFormat(std::string s)
Definition: ROL_Types.hpp:249