ROL
step/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 
48 #define USE_HESSVEC 1
49 
50 #include "ROL_TestObjectives.hpp"
51 #include "ROL_Algorithm.hpp"
52 #include "ROL_LineSearchStep.hpp"
53 #include "ROL_StatusTest.hpp"
54 #include "Teuchos_oblackholestream.hpp"
55 #include "Teuchos_GlobalMPISession.hpp"
56 #include "Teuchos_XMLParameterListHelpers.hpp"
57 
58 #include <iostream>
59 
60 typedef double RealT;
61 
62 int main(int argc, char *argv[]) {
63 
64  Teuchos::GlobalMPISession mpiSession(&argc, &argv);
65 
66  // This little trick lets us print to std::cout only if a (dummy) command-line argument is provided.
67  int iprint = argc - 1;
68  Teuchos::RCP<std::ostream> outStream;
69  Teuchos::oblackholestream bhs; // outputs nothing
70  if (iprint > 0)
71  outStream = Teuchos::rcp(&std::cout, false);
72  else
73  outStream = Teuchos::rcp(&bhs, false);
74 
75  int errorFlag = 0;
76 
77  // *** Test body.
78 
79  try {
80 
81  std::string filename = "input.xml";
82  Teuchos::RCP<Teuchos::ParameterList> parlist = Teuchos::rcp( new Teuchos::ParameterList() );
83  Teuchos::updateParametersFromXmlFile( filename, parlist.ptr() );
84  parlist->sublist("General").set("Inexact Hessian-Times-A-Vector",true);
85 #if USE_HESSVEC
86  parlist->sublist("General").set("Inexact Hessian-Times-A-Vector",false);
87 #endif
88 
89  // Define Status Test
90  Teuchos::RCP<ROL::StatusTest<RealT> > status = Teuchos::rcp(new ROL::StatusTest<RealT>(*parlist));
91 
93  *outStream << "\n\n" << ROL:: ETestOptProblemToString(prob) << "\n\n";
94 
95  // Initial Guess Vector
96  Teuchos::RCP<std::vector<RealT> > x0_rcp = Teuchos::rcp( new std::vector<RealT> );
97  ROL::StdVector<RealT> x0(x0_rcp);
98 
99  // Exact Solution Vector
100  Teuchos::RCP<std::vector<RealT> > z_rcp = Teuchos::rcp( new std::vector<RealT> );
101  ROL::StdVector<RealT> z(z_rcp);
102 
103  // Get Objective Function
104  Teuchos::RCP<ROL::Objective<RealT> > obj = Teuchos::null;
105  Teuchos::RCP<ROL::BoundConstraint<RealT> > con = Teuchos::null;
106  ROL::getTestObjectives<RealT>(obj,con,x0,z,prob);
107 
108  // Get Dimension of Problem
109  int dim =
110  Teuchos::rcp_const_cast<std::vector<RealT> >((Teuchos::dyn_cast<ROL::StdVector<RealT> >(x0)).getVector())->size();
111  parlist->sublist("General").sublist("Krylov").set("Iteration Limit", 2*dim);
112 
113  // Check Derivatives
114  Teuchos::RCP<std::vector<RealT> > d_rcp = Teuchos::rcp( new std::vector<RealT> (dim, 1.0) );
115  ROL::StdVector<RealT> d(d_rcp);
116  obj->checkGradient(x0,d);
117  obj->checkHessVec(x0,d);
118 
119  // Iteration Vector
120  Teuchos::RCP<std::vector<RealT> > x_rcp = Teuchos::rcp( new std::vector<RealT> (dim, 0.0) );
121  ROL::StdVector<RealT> x(x_rcp);
122  x.set(x0);
123 
124  // Error Vector
125  Teuchos::RCP<std::vector<RealT> > e_rcp = Teuchos::rcp( new std::vector<RealT> (dim, 0.0) );
126  ROL::StdVector<RealT> e(e_rcp);
127  e.zero();
128 
129  //ROL::EDescent desc = ROL::DESCENT_STEEPEST;
131  parlist->sublist("Step").sublist("Line Search").sublist("Descent Method").set("Type", ROL::EDescentToString(desc));
132  *outStream << "\n\n" << ROL::EDescentToString(desc) << "\n\n";
133 
134  // Define Step
135  Teuchos::RCP<ROL::LineSearchStep<RealT> > step = Teuchos::rcp(new ROL::LineSearchStep<RealT>(*parlist));
136 
137  // Define Algorithm
138  ROL::Algorithm<RealT> algo(step,status,false);
139 
140  // Run Algorithm
141  x.set(x0);
142  algo.run(x, *obj, *con, true, *outStream);
143 
144  // Compute Error
145  e.set(x);
146  e.axpy(-1.0,z);
147  *outStream << "\nNorm of Error: " << e.norm() << "\n";
148  }
149  }
150  catch (std::logic_error err) {
151  *outStream << err.what() << "\n";
152  errorFlag = -1000;
153  }; // end try
154 
155  if (errorFlag != 0)
156  std::cout << "End Result: TEST FAILED\n";
157  else
158  std::cout << "End Result: TEST PASSED\n";
159 
160  return 0;
161 
162 }
163 
ETestOptProblem
Enumeration of test optimization problems.
Definition: ROL_Types.hpp:939
void axpy(const Real alpha, const Vector< Real > &x)
Compute where .
Contains definitions of test objective functions.
int main(int argc, char *argv[])
std::string EDescentToString(EDescent tr)
Definition: ROL_Types.hpp:315
virtual void zero()
Set to zero vector.
Definition: ROL_Vector.hpp:157
double RealT
Provides the interface to compute optimization steps with line search.
Real norm() const
Returns where .
Provides the std::vector implementation of the ROL::Vector interface.
std::string ETestOptProblemToString(ETestOptProblem to)
Definition: ROL_Types.hpp:952
Provides an interface to run optimization algorithms.
Provides an interface to check status of optimization algorithms.
void set(const Vector< Real > &x)
Set where .
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.
EDescent
Enumeration of descent direction types.
Definition: ROL_Types.hpp:306