ROL
example_01a.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
57#include <iostream>
58
59#include "ROL_Sacado_Objective.hpp"
60
61#include "ROL_Algorithm.hpp"
63#include "ROL_StatusTest.hpp"
64#include "ROL_ParameterList.hpp"
65
66#include "ROL_Stream.hpp"
67#include "Teuchos_GlobalMPISession.hpp"
68
69#include "example_01a.hpp"
70
71using namespace ROL;
72
73typedef double RealT;
74
75int main(int argc, char **argv)
76{
77 Teuchos::GlobalMPISession mpiSession(&argc, &argv);
78
79 // This little trick lets us print to std::cout only if a (dummy) command-line argument is provided.
80 int iprint = argc - 1;
81 ROL::Ptr<std::ostream> outStream;
82 ROL::nullstream bhs; // outputs nothing
83 if (iprint > 0)
84 outStream = ROL::makePtrFromRef(std::cout);
85 else
86 outStream = ROL::makePtrFromRef(bhs);
87
88 int errorFlag = 0;
89
90 // *** Example body.
91
92 try {
93
94 Sacado_Objective<RealT,Zakharov> obj;
95
96 int dim = 10; // Set problem dimension.
97
98 // Load optimizer parameters form XML file
99 std::string paramfile = "parameters.xml";
100 auto parlist = ROL::getParametersFromXmlFile(paramfile);
101
102 // Define algorithm.
103 ROL::Ptr<ROL::Step<RealT>>
104 step = ROL::makePtr<ROL::LineSearchStep<RealT>>(*parlist);
105 ROL::Ptr<ROL::StatusTest<RealT>>
106 status = ROL::makePtr<ROL::StatusTest<RealT>>(*parlist);
107 ROL::Algorithm<RealT> algo(step,status,false);
108
109 // Iteration vector.
110 ROL::Ptr<std::vector<RealT> > x_ptr = ROL::makePtr<std::vector<RealT>>(dim, 0.0);
111 // Set Initial Guess
112 for (int i=0; i<dim; i++) {
113 (*x_ptr)[i] = 2;
114 }
115
116 StdVector<RealT> x(x_ptr);
117
118 // Run algorithm.
119 algo.run(x, obj, true, *outStream);
120
121 // Get true solution.
122 ROL::Ptr<std::vector<RealT> > xtrue_ptr = ROL::makePtr<std::vector<RealT>>(dim, 0.0);
123 StdVector<RealT> xtrue(xtrue_ptr);
124
125 // Compute error.
126 x.axpy(-1.0, xtrue);
127 RealT abserr = x.norm();
128 *outStream << std::scientific << "\n Absolute Error: " << abserr << std::endl;
129 if ( abserr > sqrt(ROL_EPSILON<RealT>()) ) {
130 errorFlag += 1;
131 }
132 }
133 catch (std::logic_error& err) {
134 *outStream << err.what() << "\n";
135 errorFlag = -1000;
136 }; // end try
137
138 if (errorFlag != 0)
139 std::cout << "End Result: TEST FAILED\n";
140 else
141 std::cout << "End Result: TEST PASSED\n";
142
143 return 0;
144
145}
Defines a no-output stream class ROL::NullStream and a function makeStreamPtr which either wraps a re...
Provides an interface to run optimization algorithms.
virtual std::vector< std::string > run(Vector< Real > &x, Objective< Real > &obj, bool print=false, std::ostream &outStream=std::cout, bool printVectors=false, std::ostream &vectorStream=std::cout)
Run algorithm on unconstrained problems (Type-U). This is the primary Type-U interface.
Provides the ROL::Vector interface for scalar values, to be used, for example, with scalar constraint...
void axpy(const Real alpha, const Vector< Real > &x)
Compute where .
Real norm() const
Returns where .
int main(int argc, char **argv)
double RealT
constexpr auto dim