ROL
ROL_ErrorMeasureFactory.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_ERRORMEASUREFACTORY_HPP
45 #define ROL_ERRORMEASUREFACTORY_HPP
46 
47 #include "ROL_ParameterList.hpp"
48 
49 #include "ROL_Types.hpp"
50 
51 // Risk Quadrangle Implementations
54 #include "ROL_MoreauYosidaCVaR.hpp"
61 
62 namespace ROL {
63 
74  };
75 
76  inline std::string EErrorMeasureToString(EErrorMeasure ed) {
77  std::string retString;
78  switch(ed) {
80  retString = "Least Squares"; break;
82  retString = "Huber"; break;
84  retString = "Koenker-Bassett"; break;
86  retString = "Moreau-Yosida-Koenker-Bassett"; break;
88  retString = "Generalized Moreau-Yosida-Koenker-Bassett"; break;
90  retString = "Exponential"; break;
92  retString = "Log Quantile"; break;
94  retString = "Smoothed Worst Case"; break;
95  case ERRORMEASURE_LAST:
96  retString = "Last Type (Dummy)"; break;
97  default:
98  retString = "INVALID EErrorMeasure"; break;
99  }
100  return retString;
101  }
102 
104  return( (ed == ERRORMEASURE_MEANVARIANCEQUADRANGLE) ||
112  }
113 
115  return type = static_cast<EErrorMeasure>(type+1);
116  }
117 
119  EErrorMeasure oldval = type;
120  ++type;
121  return oldval;
122  }
123 
125  return type = static_cast<EErrorMeasure>(type-1);
126  }
127 
129  EErrorMeasure oldval = type;
130  --type;
131  return oldval;
132  }
133 
134  inline EErrorMeasure StringToEErrorMeasure(std::string s) {
135  s = removeStringFormat(s);
137  if ( !s.compare(removeStringFormat(EErrorMeasureToString(tr))) ) {
138  return tr;
139  }
140  }
141  return ERRORMEASURE_LAST;
142  }
143 
144  template<class Real>
145  inline Ptr<RandVarFunctional<Real> > ErrorMeasureFactory(ROL::ParameterList &parlist) {
146  std::string risk = parlist.sublist("SOL").sublist("Error Measure").get("Name","Least Squares");
148  switch(ed) {
150  return makePtr<ExpectationQuadError<Real>>(makePtr<MeanVarianceQuadrangle<Real>>(parlist));
152  return makePtr<ExpectationQuadError<Real>>(makePtr<TruncatedMeanQuadrangle<Real>>(parlist));
154  return makePtr<ExpectationQuadError<Real>>(makePtr<QuantileQuadrangle<Real>>(parlist));
156  return makePtr<ExpectationQuadError<Real>>(makePtr<MoreauYosidaCVaR<Real>>(parlist));
158  return makePtr<ExpectationQuadError<Real>>(makePtr<GenMoreauYosidaCVaR<Real>>(parlist));
160  return makePtr<ExpectationQuadError<Real>>(makePtr<LogExponentialQuadrangle<Real>>(parlist));
162  return makePtr<ExpectationQuadError<Real>>(makePtr<LogQuantileQuadrangle<Real>>(parlist));
164  return makePtr<ExpectationQuadError<Real>>(makePtr<SmoothedWorstCaseQuadrangle<Real>>(parlist));
165  default:
166  ROL_TEST_FOR_EXCEPTION(true,std::invalid_argument,
167  "Invalid error measure type " << risk << "!");
168  }
169  }
170 }
171 #endif
std::string EErrorMeasureToString(EErrorMeasure ed)
EKrylov & operator++(EKrylov &type)
Contains definitions of custom data types in ROL.
std::string removeStringFormat(std::string s)
Definition: ROL_Types.hpp:247
Ptr< RandVarFunctional< Real > > ErrorMeasureFactory(ROL::ParameterList &parlist)
int isValidErrorMeasure(EErrorMeasure ed)
EErrorMeasure StringToEErrorMeasure(std::string s)
EKrylov & operator--(EKrylov &type)