ROL
example_01b.cpp
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 
52 #include <iostream>
53 
54 #include "ROL_Algorithm.hpp"
55 #include "ROL_LineSearchStep.hpp"
56 #include "ROL_StatusTest.hpp"
57 #include "ROL_ParameterList.hpp"
58 
59 #include "ROL_Stream.hpp"
60 #include "Teuchos_GlobalMPISession.hpp"
61 
62 #include "example_01b.hpp"
63 
64 using namespace ROL;
65 
66 typedef double RealT;
67 
68 int main(int argc, char **argv)
69 {
70  Teuchos::GlobalMPISession mpiSession(&argc, &argv);
71 
72  // This little trick lets us print to std::cout only if a (dummy) command-line argument is provided.
73  int iprint = argc - 1;
74  ROL::Ptr<std::ostream> outStream;
75  ROL::nullstream bhs; // outputs nothing
76  if (iprint > 0)
77  outStream = ROL::makePtrFromRef(std::cout);
78  else
79  outStream = ROL::makePtrFromRef(bhs);
80 
81  int errorFlag = 0;
82 
83  // *** Example body.
84 
85  try {
86 
88 
89  int dim = 10; // Set problem dimension.
90 
91  // Load optimizer parameters form XML file
92  std::string paramfile = "parameters.xml";
93  auto parlist = ROL::getParametersFromXmlFile(paramfile);
94 
95  // Define algorithm.
96  ROL::Ptr<ROL::Step<RealT>>
97  step = ROL::makePtr<ROL::LineSearchStep<RealT>>(*parlist);
98  ROL::Ptr<ROL::StatusTest<RealT>>
99  status = ROL::makePtr<ROL::StatusTest<RealT>>(*parlist);
100  ROL::Algorithm<RealT> algo(step,status,false);
101 
102  // Iteration Vector
103  ROL::Ptr<std::vector<RealT> > x_ptr = ROL::makePtr<std::vector<RealT>>(dim, 0.0);
104  // Set Initial Guess
105  for (int i=0; i<dim; i++) {
106  (*x_ptr)[i] = 2;
107  }
108 
109  StdVector<RealT> x(x_ptr);
110 
111  // Run Algorithm
112  algo.run(x, obj, true, *outStream);
113 
114  // Get True Solution
115  ROL::Ptr<std::vector<RealT> > xtrue_ptr = ROL::makePtr<std::vector<RealT>>(dim, 0.0);
116  StdVector<RealT> xtrue(xtrue_ptr);
117 
118 
119  // Compute Error
120  x.axpy(-1.0, xtrue);
121  RealT abserr = x.norm();
122  *outStream << std::scientific << "\n Absolute Error: " << abserr;
123  if ( abserr > sqrt(ROL_EPSILON<RealT>()) ) {
124  errorFlag += 1;
125  }
126  }
127  catch (std::logic_error& err) {
128  *outStream << err.what() << "\n";
129  errorFlag = -1000;
130  }; // end try
131 
132  if (errorFlag != 0)
133  std::cout << "End Result: TEST FAILED\n";
134  else
135  std::cout << "End Result: TEST PASSED\n";
136 
137  return 0;
138 
139 }
void axpy(const Real alpha, const Vector< Real > &x)
Compute where .
virtual std::vector< std::string > run(Vector< Real > &x, Objective< Real > &obj, bool print=false, std::ostream &outStream=std::cout, bool printVectors=false, std::ostream &vectorStream=std::cout)
Run algorithm on unconstrained problems (Type-U). This is the primary Type-U interface.
Defines a no-output stream class ROL::NullStream and a function makeStreamPtr which either wraps a re...
Real norm() const
Returns where .
Provides the ROL::Vector interface for scalar values, to be used, for example, with scalar constraint...
Provides an interface to run optimization algorithms.
basic_nullstream< char, char_traits< char >> nullstream
Definition: ROL_Stream.hpp:72
int main(int argc, char *argv[])
constexpr auto dim