ROL
ROL_ErrorMeasureInfo.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_ERRORMEASUREINFO_HPP
45#define ROL_ERRORMEASUREINFO_HPP
46
47#include "ROL_ParameterList.hpp"
48#include "ROL_Types.hpp"
49
50namespace ROL {
51
52template<class Real>
53inline void ErrorMeasureInfo(ROL::ParameterList &parlist, std::string &name,
54 int &nStatistic, std::vector<Real> &lower,
55 std::vector<Real> &upper, bool &isBoundActivated,
56 const bool printToStream = false,
57 std::ostream &outStream = std::cout) {
58 name = parlist.sublist("SOL").sublist("Error Measure").get<std::string>("Name");
59 lower.clear(); upper.clear();
60 nStatistic = 0; isBoundActivated = false;
61 if ( name == "Koenker-Bassett" ||
62 name == "Moreau-Yosida-Koenker-Bassett" ||
63 name == "Generalized Moreau-Yosida-Koenker-Bassett" ||
64 name == "Exponential" ||
65 name == "Least Squares" ||
66 name == "Huber" ||
67 name == "Log Quantile" ||
68 name == "Smoothed Worst Cast" ) {
69 nStatistic = 0;
70 }
71 else {
72 ROL_TEST_FOR_EXCEPTION(true,std::invalid_argument,
73 ">>> (ROL::ErrorMeasureInfo): Invalid probability " << name << "!");
74 }
75
76 // Print Information
77 if ( printToStream ) {
78 ROL::nullstream oldFormatState;
79 oldFormatState.copyfmt(outStream);
80
81 outStream << std::endl;
82 outStream << std::scientific << std::setprecision(6);
83 outStream << std::setfill('-') << std::setw(80) << "-" << std::endl;
84 outStream << " ERRORMEASURE INFORMATION" << std::endl;
85 outStream << std::setfill('-') << std::setw(80) << "-" << std::endl;
86 outStream << " NAME" << std::endl;
87 outStream << " " << name << std::endl;
88 outStream << " NUMBER OF STATISTICS" << std::endl;
89 outStream << " " << nStatistic << std::endl;
90 outStream << " ARE BOUNDS ACTIVATED" << std::endl;
91 outStream << " " << (isBoundActivated ? "TRUE" : "FALSE") << std::endl;
92 if ( isBoundActivated ) {
93 outStream << " STATISTIC LOWER BOUNDS" << std::endl;
94 for (int i = 0; i < nStatistic-1; ++i) {
95 outStream << " " << lower[i] << std::endl;
96 }
97 outStream << " " << lower[nStatistic-1] << std::endl;
98 outStream << " STATISTIC UPPER BOUNDS" << std::endl;
99 for (int i = 0; i < nStatistic-1; ++i) {
100 outStream << " " << upper[i] << std::endl;
101 }
102 outStream << " " << upper[nStatistic-1] << std::endl;
103 }
104 outStream << std::setfill('-') << std::setw(80) << "-" << std::endl;
105 outStream << std::endl;
106
107 outStream.copyfmt(oldFormatState);
108 }
109}
110
111}
112#endif
Contains definitions of custom data types in ROL.
void ErrorMeasureInfo(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)