ROL
step/fletcher/test_03.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 
47 #define USE_HESSVEC 1
48 
49 #include "ROL_GetTestProblems.hpp"
51 #include "ROL_Stream.hpp"
52 #include "Teuchos_GlobalMPISession.hpp"
53 
54 
55 #include <iostream>
56 
57 typedef double RealT;
58 
59 int main(int argc, char *argv[]) {
60 
61  Teuchos::GlobalMPISession mpiSession(&argc, &argv);
62 
63  // This little trick lets us print to std::cout only if a (dummy) command-line argument is provided.
64  int iprint = argc - 1;
65  ROL::Ptr<std::ostream> outStream;
66  ROL::nullstream bhs; // outputs nothing
67  if (iprint > 0)
68  outStream = ROL::makePtrFromRef(std::cout);
69  else
70  outStream = ROL::makePtrFromRef(bhs);
71 
72  int errorFlag = 0;
73 
74  // *** Test body.
75 
76  try {
77 
78  std::string filename = "input_ex03.xml";
79 
80  auto parlist = ROL::getParametersFromXmlFile( filename );
81  parlist->sublist("General").set("Inexact Hessian-Times-A-Vector",true);
82 #if USE_HESSVEC
83  parlist->sublist("General").set("Inexact Hessian-Times-A-Vector",false);
84 #endif
85 
86  // Krylov parameters.
87  parlist->sublist("Step").set("Type","Fletcher");
88 
90  // Get Objective Function
91  ROL::Ptr<ROL::Vector<RealT> > x0;
92  std::vector<ROL::Ptr<ROL::Vector<RealT> > > z;
93  ROL::Ptr<ROL::OptimizationProblem<RealT> > problem;
94  ROL::GetTestProblem<RealT>(problem,x0,z,prob);
95 
96  if ((problem->getProblemType() == ROL::TYPE_E || problem->getProblemType() == ROL::TYPE_EB)
98  *outStream << std::endl << std::endl << ROL:: ETestOptProblemToString(prob) << std::endl << std::endl;
99 
100  // Get Dimension of Problem
101  // int dim = x0->dimension();
102  // parlist->sublist("General").sublist("Krylov").set("Iteration Limit", 2*dim);
103 
104  // Error Vector
105  ROL::Ptr<ROL::Vector<RealT> > e = x0->clone();
106  e->zero();
107 
108  // Define Solver
109  ROL::OptimizationSolver<RealT> solver(*problem,*parlist);
110 
111  // Run Solver
112  solver.solve(*outStream);
113 
114  // Compute Error
115  RealT err(0);
116  for (int i = 0; i < static_cast<int>(z.size()); ++i) {
117  e->set(*x0);
118 std::cout << "\n\n e dim =" << e->dimension() << " z[i] dim =" << z[i]->dimension() << "\n\n";
119  e->axpy(-1.0,*z[i]);
120  if (i == 0) {
121  err = e->norm();
122  }
123  else {
124  err = std::min(err,e->norm());
125  }
126  }
127  *outStream << std::endl << "Norm of Error: " << err << std::endl;
128 
129  // Update error flag
130  ROL::Ptr<const ROL::AlgorithmState<RealT> > state = solver.getAlgorithmState();
131  errorFlag += ((err < std::max(1.e-6*z[0]->norm(),1.e-8) || (state->gnorm < 1.e-6)) ? 0 : 1);
132  }
133  }
134  }
135  catch (std::logic_error err) {
136  *outStream << err.what() << std::endl;
137  errorFlag = -1000;
138  }; // end try
139 
140  if (errorFlag != 0)
141  std::cout << "End Result: TEST FAILED" << std::endl;
142  else
143  std::cout << "End Result: TEST PASSED" << std::endl;
144 
145  return 0;
146 
147 }
ETestOptProblem
Enumeration of test optimization problems.
Contains definitions of test objective functions.
Defines a no-output stream class ROL::NullStream and a function makeStreamPtr which either wraps a re...
std::string ETestOptProblemToString(ETestOptProblem to)
Provides a simplified interface for solving a wide range of optimization problems.
basic_nullstream< char, char_traits< char >> nullstream
Definition: ROL_Stream.hpp:72
int main(int argc, char *argv[])
int solve(const ROL::Ptr< StatusTest< Real > > &status=ROL::nullPtr, const bool combineStatus=true)
Solve optimization problem with no iteration output.
ROL::Ptr< const AlgorithmState< Real > > getAlgorithmState(void) const
Return the AlgorithmState.