ROL
ROL_ProbabilityFactory.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_PROBABILITYFACTORY_HPP
45#define ROL_PROBABILITYFACTORY_HPP
46
47#include "ROL_ParameterList.hpp"
48
49#include "ROL_Types.hpp"
50#include "ROL_BPOE.hpp"
51#include "ROL_SmoothedPOE.hpp"
52
53namespace ROL {
54
59 };
60
61 inline std::string EProbabilityToString(EProbability ed) {
62 std::string retString;
63 switch(ed) {
65 retString = "bPOE"; break;
67 retString = "Smoothed POE"; break;
69 retString = "Last Type (Dummy)"; break;
70 default:
71 retString = "INVALID EProbability"; break;
72 }
73 return retString;
74 }
75
77 return( (ed == PROBABILITY_BPOE) ||
79 }
80
82 return type = static_cast<EProbability>(type+1);
83 }
84
86 EProbability oldval = type;
87 ++type;
88 return oldval;
89 }
90
92 return type = static_cast<EProbability>(type-1);
93 }
94
96 EProbability oldval = type;
97 --type;
98 return oldval;
99 }
100
101 inline EProbability StringToEProbability(std::string s) {
102 s = removeStringFormat(s);
103 for ( EProbability tr = PROBABILITY_BPOE; tr < PROBABILITY_LAST; tr++ ) {
104 if ( !s.compare(removeStringFormat(EProbabilityToString(tr))) ) {
105 return tr;
106 }
107 }
108 return PROBABILITY_LAST;
109 }
110
111 template<class Real>
112 inline Ptr<RandVarFunctional<Real>> ProbabilityFactory(ParameterList &parlist) {
113 std::string prob = parlist.sublist("SOL").sublist("Probability").get("Name","bPOE");
115 switch(ed) {
116 case PROBABILITY_BPOE:
117 return makePtr<BPOE<Real>>(parlist);
119 return makePtr<SmoothedPOE<Real>>(parlist);
120 default:
121 ROL_TEST_FOR_EXCEPTION(true,std::invalid_argument,
122 "Invalid probability type " << prob << "!");
123 }
124 }
125}
126#endif
Contains definitions of custom data types in ROL.
std::string removeStringFormat(std::string s)
Definition: ROL_Types.hpp:249
Ptr< RandVarFunctional< Real > > ProbabilityFactory(ParameterList &parlist)
std::string EProbabilityToString(EProbability ed)
EPolyProjAlgo & operator--(EPolyProjAlgo &type)
EPolyProjAlgo & operator++(EPolyProjAlgo &type)
int isValidProbability(EProbability ed)
EProbability StringToEProbability(std::string s)