ROL
step/test_01.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 0
49
52#include "ROL_Stream.hpp"
53#include "Teuchos_GlobalMPISession.hpp"
54
55
56#include <iostream>
57
58typedef double RealT;
59
60int 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 ROL::Ptr<std::ostream> outStream;
67 ROL::nullstream bhs; // outputs nothing
68 if (iprint > 0)
69 outStream = ROL::makePtrFromRef(std::cout);
70 else
71 outStream = ROL::makePtrFromRef(bhs);
72
73 int errorFlag = 0;
74
75 // *** Test body.
76
77 try {
78
79 std::string filename = "input.xml";
80
81 auto parlist = ROL::getParametersFromXmlFile( filename );
82 parlist->sublist("General").set("Inexact Hessian-Times-A-Vector",true);
83#if USE_HESSVEC
84 parlist->sublist("General").set("Inexact Hessian-Times-A-Vector",false);
85#endif
86 parlist->sublist("Step").set("Type","Line Search");
87
89 for ( ROL::EDescent desc = ROL::DESCENT_STEEPEST; desc < ROL::DESCENT_LAST; desc++ ) {
90 // Set up optimization problem
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,objFunc);
95 if (problem->getProblemType() == ROL::TYPE_U
98 && objFunc != ROL::TESTOPTPROBLEM_MINIMAX3) {
99 *outStream << std::endl << std::endl << ROL::ETestOptProblemToString(objFunc) << std::endl << std::endl;
100
101 // Get Dimension of Problem
102 int dim = x0->dimension();
103 parlist->sublist("General").sublist("Krylov").set("Iteration Limit", 2*dim);
104
105 // Error Vector
106 ROL::Ptr<ROL::Vector<RealT> > e = x0->clone();
107 e->zero();
108
109 parlist->sublist("Step").sublist("Line Search").sublist("Descent Method").set("Type", ROL::EDescentToString(desc));
110 if ( desc == ROL::DESCENT_NEWTON &&
111 ((objFunc == ROL::TESTOPTPROBLEM_LEASTSQUARES) ||
114 parlist->sublist("Step").sublist("Line Search").sublist("Descent Method").set("Type", ROL::EDescentToString(ROL::DESCENT_NEWTONKRYLOV));
115 }
116 *outStream << std::endl << std::endl << ROL::EDescentToString(desc) << std::endl << std::endl;
117
118 // Define Solver
119 ROL::OptimizationSolver<RealT> solver(*problem,*parlist);
120
121 // Run Solver
122 solver.solve(*outStream);
123
124 // Compute Error
125 RealT err(0);
126 for (int i = 0; i < static_cast<int>(z.size()); ++i) {
127 e->set(*x0);
128 e->axpy(-1.0,*z[i]);
129 if (i == 0) {
130 err = e->norm();
131 }
132 else {
133 err = std::min(err,e->norm());
134 }
135 }
136 *outStream << std::endl << "Norm of Error: " << err << std::endl;
137 //errorFlag += (int)(e.norm() < std::sqrt(ROL::ROL_EPSILON<RealT>()));
138 }
139 }
140 }
141 }
142 catch (std::logic_error& err) {
143 *outStream << err.what() << std::endl;
144 errorFlag = -1000;
145 }; // end try
146
147 if (errorFlag != 0)
148 std::cout << "End Result: TEST FAILED" << std::endl;
149 else
150 std::cout << "End Result: TEST PASSED" << std::endl;
151
152 return 0;
153
154}
Contains definitions of test objective functions.
Defines a no-output stream class ROL::NullStream and a function makeStreamPtr which either wraps a re...
Provides a simplified interface for solving a wide range of optimization problems.
int solve(const ROL::Ptr< StatusTest< Real > > &status=ROL::nullPtr, const bool combineStatus=true)
Solve optimization problem with no iteration output.
std::string ETestOptProblemToString(ETestOptProblem to)
@ TESTOPTPROBLEM_ROSENBROCK
@ TESTOPTPROBLEM_LEASTSQUARES
@ TESTOPTPROBLEM_POISSONINVERSION
@ TESTOPTPROBLEM_POISSONCONTROL
@ DESCENT_NEWTONKRYLOV
@ DESCENT_LAST
@ DESCENT_STEEPEST
@ DESCENT_NEWTON
std::string EDescentToString(EDescent tr)
@ TYPE_U
int main(int argc, char *argv[])
double RealT
constexpr auto dim