ROL
step/test_02.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 
48 #define USE_HESSVEC 1
49 
50 #include "ROL_TestObjectives.hpp"
51 #include "ROL_Algorithm.hpp"
52 #include "Teuchos_oblackholestream.hpp"
53 #include "Teuchos_GlobalMPISession.hpp"
54 #include "Teuchos_XMLParameterListHelpers.hpp"
55 
56 #include <iostream>
57 
58 typedef double RealT;
59 
60 int main(int argc, char *argv[]) {
61 
62  Teuchos::GlobalMPISession mpiSession(&argc, &argv);
63 
64  // This little trick lets us print to std::cout only if a (dummy) command-line argument is provided.
65  int iprint = argc - 1;
66  Teuchos::RCP<std::ostream> outStream;
67  Teuchos::oblackholestream bhs; // outputs nothing
68  if (iprint > 0)
69  outStream = Teuchos::rcp(&std::cout, false);
70  else
71  outStream = Teuchos::rcp(&bhs, false);
72 
73  int errorFlag = 0;
74 
75  // *** Test body.
76 
77  try {
78 
79  std::string filename = "input.xml";
80  Teuchos::RCP<Teuchos::ParameterList> parlist = Teuchos::rcp( new Teuchos::ParameterList() );
81  Teuchos::updateParametersFromXmlFile( filename, parlist.ptr() );
82 
83  // Loop Through Test Objectives
84  for ( ROL::ETestObjectives objFunc = ROL::TESTOBJECTIVES_ROSENBROCK; objFunc < ROL::TESTOBJECTIVES_LAST; objFunc++ ) {
85  *outStream << std::endl << std::endl << ROL::ETestObjectivesToString(objFunc) << std::endl << std::endl;
86 
87  // Set Up Optimization Problem
88  Teuchos::RCP<ROL::Vector<RealT> > x0, z;
89  Teuchos::RCP<ROL::Objective<RealT> > obj = Teuchos::null;
90  ROL::getTestObjectives<RealT>(obj,x0,z,objFunc);
91  Teuchos::RCP<ROL::Vector<RealT> > x = x0->clone();
92 
93  // Get Dimension of Problem
94  int dim = x0->dimension();
95  parlist->sublist("General").sublist("Krylov").set("Iteration Limit", 5*dim);
96 
97  // Error Vector
98  Teuchos::RCP<ROL::Vector<RealT> > e = x0->clone();
99  e->zero();
100 
102  *outStream << "\n\n" << ROL::ETrustRegionToString(tr) << "\n\n";
103  parlist->sublist("Step").sublist("Trust Region").set("Subproblem Solver", ETrustRegionToString(tr));
104 
105  // Define Algorithm
106  ROL::Algorithm<RealT> algo("Trust Region",*parlist,false);
107 
108  // Run Algorithm
109  x->set(*x0);
110  algo.run(*x, *obj, true, *outStream);
111 
112  // Compute Error
113  e->set(*x);
114  e->axpy(-1.0,*z);
115  *outStream << std::endl << "Norm of Error: " << e->norm() << std::endl;
116  }
117  }
118  }
119  catch (std::logic_error err) {
120  *outStream << err.what() << std::endl;
121  errorFlag = -1000;
122  }; // end try
123 
124  if (errorFlag != 0)
125  std::cout << "End Result: TEST FAILED" << std::endl;
126  else
127  std::cout << "End Result: TEST PASSED" << std::endl;
128 
129  return 0;
130 
131 }
132 
double RealT
Contains definitions of test objective functions.
Provides an interface to run optimization algorithms.
ETestObjectives
Enumeration of test objective functions.
Definition: ROL_Types.hpp:859
std::string ETestObjectivesToString(ETestObjectives to)
Definition: ROL_Types.hpp:872
virtual std::vector< std::string > run(Vector< Real > &x, Objective< Real > &obj, bool print=false, std::ostream &outStream=std::cout)
Run algorithm on unconstrained problems (Type-U). This is the primary Type-U interface.
ETrustRegion
Enumeration of trust-region solver types.
Definition: ROL_Types.hpp:786
std::string ETrustRegionToString(ETrustRegion tr)
Definition: ROL_Types.hpp:794
int main(int argc, char *argv[])