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
54
55namespace ROL {
56
74
75inline std::string EPolyProjAlgoToString(EPolyProjAlgo alg) {
76 std::string retString;
77 switch(alg) {
78 case PPA_DAIFLETCHER: retString = "Dai-Fletcher"; break;
79 case PPA_DYKSTRA: retString = "Dysktra"; break;
80 case PPA_DOUGLASRACHFORD: retString = "Douglas-Rachford"; break;
81 case PPA_NEWTON: retString = "Semismooth Newton"; break;
82 case PPA_RIDDERS: retString = "Ridders"; break;
83 case PPA_BRENTS: retString = "Brents"; break;
84 case PPA_LAST: retString = "Last Type (Dummy)"; break;
85 default: retString = "INVALID EPolyProjAlgo";
86 }
87 return retString;
88}
89
96 return( (alg == PPA_DAIFLETCHER) ||
97 (alg == PPA_DYKSTRA) ||
98 (alg == PPA_DOUGLASRACHFORD) ||
99 (alg == PPA_NEWTON) ||
100 (alg == PPA_RIDDERS) ||
101 (alg == PPA_BRENTS) ||
102 (alg == PPA_LAST)
103 );
104}
105
107 return type = static_cast<EPolyProjAlgo>(type+1);
108}
109
111 EPolyProjAlgo oldval = type;
112 ++type;
113 return oldval;
114}
115
117 return type = static_cast<EPolyProjAlgo>(type-1);
118}
119
121 EPolyProjAlgo oldval = type;
122 --type;
123 return oldval;
124}
125
127 s = removeStringFormat(s);
128 for ( EPolyProjAlgo alg = PPA_DAIFLETCHER; alg < PPA_LAST; alg++ ) {
129 if ( !s.compare(removeStringFormat(EPolyProjAlgoToString(alg))) ) {
130 return alg;
131 }
132 }
133 return PPA_DYKSTRA;
134}
135
136template<typename Real>
137inline Ptr<PolyhedralProjection<Real>> PolyhedralProjectionFactory(const Vector<Real> &xprim,
138 const Vector<Real> &xdual,
139 const Ptr<BoundConstraint<Real>> &bnd,
140 const Ptr<Constraint<Real>> &con,
141 const Vector<Real> &mul,
142 const Vector<Real> &res,
143 ParameterList &list) {
144 EPolyProjAlgo ealg = StringToEPolyProjAlgo(list.sublist("General").sublist("Polyhedral Projection").get("Type","Dykstra"));
145 switch(ealg) {
146 case PPA_DAIFLETCHER: return makePtr<DaiFletcherProjection<Real>>(xprim,xdual,bnd,con,mul,res,list); break;
147 case PPA_DYKSTRA: return makePtr<DykstraProjection<Real>>(xprim,xdual,bnd,con,mul,res,list); break;
148 case PPA_DOUGLASRACHFORD: return makePtr<DouglasRachfordProjection<Real>>(xprim,xdual,bnd,con,mul,res,list); break;
149 case PPA_NEWTON: return makePtr<SemismoothNewtonProjection<Real>>(xprim,xdual,bnd,con,mul,res,list); break;
150 case PPA_RIDDERS: return makePtr<RiddersProjection<Real>>(xprim,xdual,bnd,con,mul,res,list); break;
151 case PPA_BRENTS: return makePtr<BrentsProjection<Real>>(xprim,xdual,bnd,con,mul,res,list); break;
152 default: return nullPtr;
153 }
154}
155} // namespace ROL
156
157#endif
Provides the interface to apply upper and lower bound constraints.
Defines the general constraint operator interface.
Defines the linear algebra or vector space interface.
std::string removeStringFormat(std::string s)
std::string EPolyProjAlgoToString(EPolyProjAlgo alg)
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)
EPolyProjAlgo & operator--(EPolyProjAlgo &type)
EPolyProjAlgo StringToEPolyProjAlgo(std::string s)
EPolyProjAlgo & operator++(EPolyProjAlgo &type)
int isValidPolyProjAlgo(EPolyProjAlgo alg)
Verifies validity of a PolyProjAlgo enum.