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"
62 #include "ROL_LineSearchStep.hpp"
63 #include "ROL_StatusTest.hpp"
64 
65 #include "Teuchos_oblackholestream.hpp"
66 #include "Teuchos_GlobalMPISession.hpp"
67 #include "Teuchos_XMLParameterListHelpers.hpp"
68 
69 #include "example_01a.hpp"
70 
71 using namespace ROL;
72 
73 typedef double RealT;
74 
75 int 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  Teuchos::RCP<std::ostream> outStream;
82  Teuchos::oblackholestream bhs; // outputs nothing
83  if (iprint > 0)
84  outStream = Teuchos::rcp(&std::cout, false);
85  else
86  outStream = Teuchos::rcp(&bhs, false);
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  Teuchos::RCP<Teuchos::ParameterList> parlist = Teuchos::rcp(new Teuchos::ParameterList());
100  std::string paramfile = "parameters.xml";
101  Teuchos::updateParametersFromXmlFile(paramfile,parlist.ptr());
102 
103  // Define algorithm.
104  Algorithm<RealT> algo("Line Search",*parlist);
105 
106  // Iteration vector.
107  Teuchos::RCP<std::vector<RealT> > x_rcp = Teuchos::rcp( new std::vector<RealT> (dim, 0.0) );
108  // Set Initial Guess
109  for (int i=0; i<dim; i++) {
110  (*x_rcp)[i] = 2;
111  }
112 
113  StdVector<RealT> x(x_rcp);
114 
115  // Run algorithm.
116  algo.run(x, obj, true, *outStream);
117 
118  // Get true solution.
119  Teuchos::RCP<std::vector<RealT> > xtrue_rcp = Teuchos::rcp( new std::vector<RealT> (dim, 0.0) );
120  StdVector<RealT> xtrue(xtrue_rcp);
121 
122  // Compute error.
123  x.axpy(-1.0, xtrue);
124  RealT abserr = x.norm();
125  *outStream << std::scientific << "\n Absolute Error: " << abserr << std::endl;
126  if ( abserr > sqrt(ROL_EPSILON) ) {
127  errorFlag += 1;
128  }
129  }
130  catch (std::logic_error err) {
131  *outStream << err.what() << "\n";
132  errorFlag = -1000;
133  }; // end try
134 
135  if (errorFlag != 0)
136  std::cout << "End Result: TEST FAILED\n";
137  else
138  std::cout << "End Result: TEST PASSED\n";
139 
140  return 0;
141 
142 }
int main(int argc, char **argv)
Definition: example_01a.cpp:75
void axpy(const Real alpha, const Vector< Real > &x)
Compute where .
double RealT
Definition: example_01a.cpp:73
Real norm() const
Returns where .
Provides the std::vector implementation of the ROL::Vector interface.
Provides an interface to run optimization algorithms.
double RealT
static const double ROL_EPSILON
Platform-dependent machine epsilon.
Definition: ROL_Types.hpp:118