ROL
ROL_RandVarFunctionalInfo.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_RANDVARFUNCTIONALINFO_HPP
45#define ROL_RANDVARFUNCTIONALINFO_HPP
46
52
53namespace ROL {
54
55template<class Real>
56inline void RandVarFunctionalInfo(ROL::ParameterList &parlist, std::string &name,
57 int &nStatistic, std::vector<Real> &lower,
58 std::vector<Real> &upper, bool &isBoundActivated,
59 const bool printToStream = false,
60 std::ostream &outStream = std::cout) {
61 std::string type = parlist.sublist("SOL").get("Type","Risk Averse");
62 if (type == "Risk Averse") {
63 RiskMeasureInfo<Real>(parlist,name,nStatistic,lower,upper,isBoundActivated,printToStream,outStream);
64 }
65 else if (type == "Deviation") {
66 DeviationMeasureInfo<Real>(parlist,name,nStatistic,lower,upper,isBoundActivated,printToStream,outStream);
67 }
68 else if (type == "Error") {
69 ErrorMeasureInfo<Real>(parlist,name,nStatistic,lower,upper,isBoundActivated,printToStream,outStream);
70 }
71 else if (type == "Regret") {
72 RegretMeasureInfo<Real>(parlist,name,nStatistic,lower,upper,isBoundActivated,printToStream,outStream);
73 }
74 else if (type == "Probability") {
75 ProbabilityInfo<Real>(parlist,name,nStatistic,lower,upper,isBoundActivated,printToStream,outStream);
76 }
77 else {
78 ROL_TEST_FOR_EXCEPTION(true,std::invalid_argument,
79 ">>> (ROL::RandVarFunctionalInfo): Invalid random variable functional type!");
80 }
81
82 // Print Information
83 if ( printToStream ) {
84 ROL::nullstream oldFormatState;
85 oldFormatState.copyfmt(outStream);
86
87 outStream << std::endl;
88 outStream << std::scientific << std::setprecision(6);
89 outStream << std::setfill('-') << std::setw(80) << "-" << std::endl;
90 outStream << " RANDVARFUNCTIONAL INFORMATION" << std::endl;
91 outStream << std::setfill('-') << std::setw(80) << "-" << std::endl;
92 outStream << " NAME" << std::endl;
93 outStream << " " << name << std::endl;
94 outStream << " NUMBER OF STATISTICS" << std::endl;
95 outStream << " " << nStatistic << std::endl;
96 outStream << " ARE BOUNDS ACTIVATED" << std::endl;
97 outStream << " " << (isBoundActivated ? "TRUE" : "FALSE") << std::endl;
98 if ( isBoundActivated ) {
99 outStream << " STATISTIC LOWER BOUNDS" << std::endl;
100 for (int i = 0; i < nStatistic-1; ++i) {
101 outStream << " " << lower[i] << std::endl;
102 }
103 outStream << " " << lower[nStatistic-1] << std::endl;
104 outStream << " STATISTIC UPPER BOUNDS" << std::endl;
105 for (int i = 0; i < nStatistic-1; ++i) {
106 outStream << " " << upper[i] << std::endl;
107 }
108 outStream << " " << upper[nStatistic-1] << std::endl;
109 }
110 outStream << std::setfill('-') << std::setw(80) << "-" << std::endl;
111 outStream << std::endl;
112
113 outStream.copyfmt(oldFormatState);
114 }
115}
116
117}
118#endif
void RandVarFunctionalInfo(ROL::ParameterList &parlist, std::string &name, int &nStatistic, std::vector< Real > &lower, std::vector< Real > &upper, bool &isBoundActivated, const bool printToStream=false, std::ostream &outStream=std::cout)