ROL
ROL_PolyhedralProjectionFactory.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 
45 #ifndef ROL_POLYHEDRALPROJECTIONFACTORY_H
46 #define ROL_POLYHEDRALPROJECTIONFACTORY_H
47 
52 
53 namespace ROL {
54 
69 };
70 
71 inline std::string EPolyProjAlgoToString(EPolyProjAlgo alg) {
72  std::string retString;
73  switch(alg) {
74  case PPA_DAIFLETCHER: retString = "Dai-Fletcher"; break;
75  case PPA_DYKSTRA: retString = "Dysktra"; break;
76  case PPA_NEWTON: retString = "Semismooth Newton"; break;
77  case PPA_RIDDERS: retString = "Ridders"; break;
78  case PPA_LAST: retString = "Last Type (Dummy)"; break;
79  default: retString = "INVALID EPolyProjAlgo";
80  }
81  return retString;
82 }
83 
90  return( (alg == PPA_DAIFLETCHER) ||
91  (alg == PPA_DYKSTRA) ||
92  (alg == PPA_NEWTON) ||
93  (alg == PPA_RIDDERS) ||
94  (alg == PPA_LAST)
95  );
96 }
97 
99  return type = static_cast<EPolyProjAlgo>(type+1);
100 }
101 
103  EPolyProjAlgo oldval = type;
104  ++type;
105  return oldval;
106 }
107 
109  return type = static_cast<EPolyProjAlgo>(type-1);
110 }
111 
113  EPolyProjAlgo oldval = type;
114  --type;
115  return oldval;
116 }
117 
118 inline EPolyProjAlgo StringToEPolyProjAlgo(std::string s) {
119  s = removeStringFormat(s);
120  for ( EPolyProjAlgo alg = PPA_DAIFLETCHER; alg < PPA_LAST; alg++ ) {
121  if ( !s.compare(removeStringFormat(EPolyProjAlgoToString(alg))) ) {
122  return alg;
123  }
124  }
125  return PPA_DYKSTRA;
126 }
127 
128 template<typename Real>
129 inline Ptr<PolyhedralProjection<Real>> PolyhedralProjectionFactory(const Vector<Real> &xprim,
130  const Vector<Real> &xdual,
131  const Ptr<BoundConstraint<Real>> &bnd,
132  const Ptr<Constraint<Real>> &con,
133  const Vector<Real> &mul,
134  const Vector<Real> &res,
135  ParameterList &list) {
136  EPolyProjAlgo ealg = StringToEPolyProjAlgo(list.sublist("General").sublist("Polyhedral Projection").get("Type","Dykstra"));
137  switch(ealg) {
138  case PPA_DAIFLETCHER: return makePtr<DaiFletcherProjection<Real>>(xprim,xdual,bnd,con,mul,res,list); break;
139  case PPA_DYKSTRA: return makePtr<DykstraProjection<Real>>(xprim,xdual,bnd,con,mul,res,list); break;
140  case PPA_NEWTON: return makePtr<SemismoothNewtonProjection<Real>>(xprim,xdual,bnd,con,mul,res,list); break;
141  case PPA_RIDDERS: return makePtr<RiddersProjection<Real>>(xprim,xdual,bnd,con,mul,res,list); break;
142  default: return nullPtr;
143  }
144 }
145 } // namespace ROL
146 
147 #endif
std::string EPolyProjAlgoToString(EPolyProjAlgo alg)
EPolyProjAlgo StringToEPolyProjAlgo(std::string s)
EPolyProjAlgo & operator++(EPolyProjAlgo &type)
Ptr< PolyhedralProjection< Real > > PolyhedralProjectionFactory(const Vector< Real > &xprim, const Vector< Real > &xdual, const Ptr< BoundConstraint< Real >> &bnd, const Ptr< Constraint< Real >> &con, const Vector< Real > &mul, const Vector< Real > &res, ParameterList &list)
std::string removeStringFormat(std::string s)
Definition: ROL_Types.hpp:247
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:80
EPolyProjAlgo
Enumeration of polyhedral projecdtion algorithm types.
EPolyProjAlgo & operator--(EPolyProjAlgo &type)
int isValidPolyProjAlgo(EPolyProjAlgo alg)
Verifies validity of a PolyProjAlgo enum.
Provides the interface to apply upper and lower bound constraints.
Defines the general constraint operator interface.