ROL
test_05.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"
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 
92  // Krylov parameters.
93  parlist->sublist("General").sublist("Krylov").set("Type", "Conjugate Residuals");
94  parlist->sublist("General").sublist("Krylov").set("Absolute Tolerance", 1.e-8);
95  parlist->sublist("General").sublist("Krylov").set("Relative Tolerance", 1.e-4);
96  parlist->sublist("General").sublist("Krylov").set("Iteration Limit", 50);
97 
99  if ( prob != ROL::TESTOPTPROBLEM_HS5 ) {
100  // PDAS parameters.
101  switch (prob) {
107  parlist->sublist("Step").sublist("Primal Dual Active Set").set("Relative Step Tolerance",1.e-10);
108  parlist->sublist("Step").sublist("Primal Dual Active Set").set("Relative Gradient Tolerance",1.e-8);
109  parlist->sublist("Step").sublist("Primal Dual Active Set").set("Iteration Limit",1);
110  parlist->sublist("Step").sublist("Primal Dual Active Set").set("Dual Scaling",1.e8);
111  break;
113  parlist->sublist("Step").sublist("Primal Dual Active Set").set("Relative Step Tolerance",1.e-10);
114  parlist->sublist("Step").sublist("Primal Dual Active Set").set("Relative Gradient Tolerance",1.e-8);
115  parlist->sublist("Step").sublist("Primal Dual Active Set").set("Iteration Limit",10);
116  parlist->sublist("Step").sublist("Primal Dual Active Set").set("Dual Scaling",1.e-2);
117  break;
119  parlist->sublist("Step").sublist("Primal Dual Active Set").set("Relative Step Tolerance",1.e-10);
120  parlist->sublist("Step").sublist("Primal Dual Active Set").set("Relative Gradient Tolerance",1.e-8);
121  parlist->sublist("Step").sublist("Primal Dual Active Set").set("Iteration Limit",10);
122  parlist->sublist("Step").sublist("Primal Dual Active Set").set("Dual Scaling",1.e10);
123  break;
125  parlist->sublist("Step").sublist("Primal Dual Active Set").set("Relative Step Tolerance",1.e-10);
126  parlist->sublist("Step").sublist("Primal Dual Active Set").set("Relative Gradient Tolerance",1.e-8);
127  parlist->sublist("Step").sublist("Primal Dual Active Set").set("Iteration Limit",1);
128  parlist->sublist("Step").sublist("Primal Dual Active Set").set("Dual Scaling",1.e-3);
129  break;
131  parlist->sublist("Step").sublist("Primal Dual Active Set").set("Relative Step Tolerance",1.e-10);
132  parlist->sublist("Step").sublist("Primal Dual Active Set").set("Relative Gradient Tolerance",1.e-8);
133  parlist->sublist("Step").sublist("Primal Dual Active Set").set("Iteration Limit",1);
134  parlist->sublist("Step").sublist("Primal Dual Active Set").set("Dual Scaling",1.e0);
135  break;
136  case ROL::TESTOPTPROBLEM_LAST: break;
137  }
138  *outStream << "\n\n" << ROL:: ETestOptProblemToString(prob) << "\n\n";
139 
140  // Initial Guess Vector
141  Teuchos::RCP<std::vector<RealT> > x0_rcp = Teuchos::rcp( new std::vector<RealT> );
142  ROL::StdVector<RealT> x0(x0_rcp);
143 
144  // Exact Solution Vector
145  Teuchos::RCP<std::vector<RealT> > z_rcp = Teuchos::rcp( new std::vector<RealT> );
146  ROL::StdVector<RealT> z(z_rcp);
147 
148  // Get Objective Function
149  Teuchos::RCP<ROL::Objective<RealT> > obj = Teuchos::null;
150  Teuchos::RCP<ROL::BoundConstraint<RealT> > con = Teuchos::null;
151  ROL::getTestObjectives<RealT>(obj,con,x0,z,prob);
152 
153  // Get Dimension of Problem
154  int dim =
155  Teuchos::rcp_const_cast<std::vector<RealT> >(
156  (Teuchos::dyn_cast<ROL::StdVector<RealT> >(x0)).getVector())->size();
157  parlist->sublist("General").sublist("Krylov").set("Iteration Limit", 2*dim);
158 
159  // Check Derivatives
160  //Teuchos::RCP<std::vector<RealT> > d_rcp = Teuchos::rcp( new std::vector<RealT> (dim, 1.0) );
161  //ROL::StdVector<RealT> d(d_rcp);
162  //obj->checkGradient(x0,d);
163  //obj->checkHessVec(x0,d);
164 
165  // Iteration Vector
166  Teuchos::RCP<std::vector<RealT> > x_rcp = Teuchos::rcp( new std::vector<RealT> (dim, 0.0) );
167  ROL::StdVector<RealT> x(x_rcp);
168  x.set(x0);
169 
170  // Error Vector
171  Teuchos::RCP<std::vector<RealT> > e_rcp = Teuchos::rcp( new std::vector<RealT> (dim, 0.0) );
172  ROL::StdVector<RealT> e(e_rcp);
173  e.zero();
174 
175  // Define Step
176  Teuchos::RCP<ROL::PrimalDualActiveSetStep<RealT> > step = Teuchos::rcp(new ROL::PrimalDualActiveSetStep<RealT>(*parlist));
177 
178  // Define Algorithm
179  ROL::Algorithm<RealT> algo(step,status,false);
180 
181  // Run Algorithm
182  x.set(x0);
183  algo.run(x, *obj, *con, true, *outStream);
184 
185  // Compute Error
186  e.set(x);
187  e.axpy(-1.0,z);
188  *outStream << "\nNorm of Error: " << e.norm() << "\n";
189 
190  // Update error flag
191  Teuchos::RCP<const ROL::AlgorithmState<RealT> > state = algo.getState();
192  errorFlag += ((e.norm() < std::max(1.e-6*z.norm(),1.e-8) || (state->gnorm < 1.e-6)) ? 0 : 1);
193  }
194  }
195  }
196  catch (std::logic_error err) {
197  *outStream << err.what() << "\n";
198  errorFlag = -1000;
199  }; // end try
200 
201  if (errorFlag != 0)
202  std::cout << "End Result: TEST FAILED\n";
203  else
204  std::cout << "End Result: TEST PASSED\n";
205 
206  return 0;
207 
208 }
209 
ETestOptProblem
Enumeration of test optimization problems.
Definition: ROL_Types.hpp:939
Implements the computation of optimization steps with the Newton primal-dual active set method...
void axpy(const Real alpha, const Vector< Real > &x)
Compute where .
Teuchos::RCP< const AlgorithmState< Real > > getState(void) const
Contains definitions of test objective functions.
virtual void zero()
Set to zero vector.
Definition: ROL_Vector.hpp:157
double RealT
Definition: test_05.cpp:60
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.
int main(int argc, char *argv[])
Definition: test_05.cpp:62
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.