ROL
step/test_01.cpp
Go to the documentation of this file.
1 // @HEADER
2 // *****************************************************************************
3 // Rapid Optimization Library (ROL) Package
4 //
5 // Copyright 2014 NTESS and the ROL contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
14 #define USE_HESSVEC 0
15 
16 #include "ROL_GetTestProblems.hpp"
18 #include "ROL_Stream.hpp"
19 #include "Teuchos_GlobalMPISession.hpp"
20 
21 
22 #include <iostream>
23 
24 typedef double RealT;
25 
26 int main(int argc, char *argv[]) {
27 
28  Teuchos::GlobalMPISession mpiSession(&argc, &argv);
29 
30  // This little trick lets us print to std::cout only if a (dummy) command-line argument is provided.
31  int iprint = argc - 1;
32  ROL::Ptr<std::ostream> outStream;
33  ROL::nullstream bhs; // outputs nothing
34  if (iprint > 0)
35  outStream = ROL::makePtrFromRef(std::cout);
36  else
37  outStream = ROL::makePtrFromRef(bhs);
38 
39  int errorFlag = 0;
40 
41  // *** Test body.
42 
43  try {
44 
45  std::string filename = "input.xml";
46 
47  auto parlist = ROL::getParametersFromXmlFile( filename );
48  parlist->sublist("General").set("Inexact Hessian-Times-A-Vector",true);
49 #if USE_HESSVEC
50  parlist->sublist("General").set("Inexact Hessian-Times-A-Vector",false);
51 #endif
52  parlist->sublist("Step").set("Type","Line Search");
53 
54  for ( ROL::ETestOptProblem objFunc = ROL::TESTOPTPROBLEM_ROSENBROCK; objFunc < ROL::TESTOPTPROBLEM_LAST; objFunc++ ) {
55  for ( ROL::EDescent desc = ROL::DESCENT_STEEPEST; desc < ROL::DESCENT_LAST; desc++ ) {
56  // Set up optimization problem
57  ROL::Ptr<ROL::Vector<RealT> > x0;
58  std::vector<ROL::Ptr<ROL::Vector<RealT> > > z;
59  ROL::Ptr<ROL::OptimizationProblem<RealT> > problem;
60  ROL::GetTestProblem<RealT>(problem,x0,z,objFunc);
61  if (problem->getProblemType() == ROL::TYPE_U
62  && objFunc != ROL::TESTOPTPROBLEM_MINIMAX1
63  && objFunc != ROL::TESTOPTPROBLEM_MINIMAX2
64  && objFunc != ROL::TESTOPTPROBLEM_MINIMAX3) {
65  *outStream << std::endl << std::endl << ROL::ETestOptProblemToString(objFunc) << std::endl << std::endl;
66 
67  // Get Dimension of Problem
68  int dim = x0->dimension();
69  parlist->sublist("General").sublist("Krylov").set("Iteration Limit", 2*dim);
70 
71  // Error Vector
72  ROL::Ptr<ROL::Vector<RealT> > e = x0->clone();
73  e->zero();
74 
75  parlist->sublist("Step").sublist("Line Search").sublist("Descent Method").set("Type", ROL::EDescentToString(desc));
76  if ( desc == ROL::DESCENT_NEWTON &&
77  ((objFunc == ROL::TESTOPTPROBLEM_LEASTSQUARES) ||
79  (objFunc == ROL::TESTOPTPROBLEM_POISSONINVERSION)) ) {
80  parlist->sublist("Step").sublist("Line Search").sublist("Descent Method").set("Type", ROL::EDescentToString(ROL::DESCENT_NEWTONKRYLOV));
81  }
82  *outStream << std::endl << std::endl << ROL::EDescentToString(desc) << std::endl << std::endl;
83 
84  // Define Solver
85  ROL::OptimizationSolver<RealT> solver(*problem,*parlist);
86 
87  // Run Solver
88  solver.solve(*outStream);
89 
90  // Compute Error
91  RealT err(0);
92  for (int i = 0; i < static_cast<int>(z.size()); ++i) {
93  e->set(*x0);
94  e->axpy(-1.0,*z[i]);
95  if (i == 0) {
96  err = e->norm();
97  }
98  else {
99  err = std::min(err,e->norm());
100  }
101  }
102  *outStream << std::endl << "Norm of Error: " << err << std::endl;
103  //errorFlag += (int)(e.norm() < std::sqrt(ROL::ROL_EPSILON<RealT>()));
104  }
105  }
106  }
107  }
108  catch (std::logic_error& err) {
109  *outStream << err.what() << std::endl;
110  errorFlag = -1000;
111  }; // end try
112 
113  if (errorFlag != 0)
114  std::cout << "End Result: TEST FAILED" << std::endl;
115  else
116  std::cout << "End Result: TEST PASSED" << std::endl;
117 
118  return 0;
119 
120 }
ETestOptProblem
Enumeration of test optimization problems.
Contains definitions of test objective functions.
std::string EDescentToString(EDescent tr)
Definition: ROL_Types.hpp:386
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:38
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.
constexpr auto dim
EDescent
Enumeration of descent direction types.
Definition: ROL_Types.hpp:377