ROL
vector/test_06.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 #include "ROL_ProfiledVector.hpp"
49 #include "ROL_StdVector.hpp"
50 #include "ROL_Zakharov.hpp"
51 #include "ROL_Algorithm.hpp"
52 
53 
54 
55 #include "ROL_Stream.hpp"
56 #include "Teuchos_GlobalMPISession.hpp"
57 
58 typedef int OrdinalT;
59 typedef double RealT;
60 
61 template<>
64 
65 int main(int argc, char *argv[]) {
66 
67 
68  using ROL::ParameterList;
69 
70  typedef std::vector<RealT> vector;
71 
72  typedef ROL::Vector<RealT> V;
73  typedef ROL::StdVector<RealT> SV;
74 
75  Teuchos::GlobalMPISession mpiSession(&argc, &argv,0);
76 
77  int iprint = argc - 1;
78  ROL::Ptr<std::ostream> outStream;
79  ROL::nullstream bhs; // outputs nothing
80  if (iprint > 0)
81  outStream = ROL::makePtrFromRef(std::cout);
82  else
83  outStream = ROL::makePtrFromRef(bhs);
84 
85  int errorFlag = 0;
86 
87  try {
88  // Dimension of the optimization vector
89  int dim = 10;
90 
91  std::string paramfile = "parameters.xml";
92  auto parlist = ROL::getParametersFromXmlFile(paramfile);
93 
94  // Define algorithm.
95  ROL::Algorithm<RealT> algo("Trust-Region",*parlist);
96 
97  ROL::Ptr<vector> x_ptr = ROL::makePtr<vector>(dim,1.0);
98  ROL::Ptr<vector> k_ptr = ROL::makePtr<vector>(dim);
99 
100  for(int i=0;i<dim;++i) {
101  (*k_ptr)[i] = 1.0 + i;
102  }
103 
104  ROL::Ptr<V> xs = ROL::makePtr<SV>(x_ptr);
105  ROL::Ptr<V> ks = ROL::makePtr<SV>(k_ptr);
106 
107  // Create ProfiledVector objects
109  ROL::Ptr<V> kpf = ROL::makePtr<ROL::ProfiledVector<int,RealT>>(ks);
110 
112 
113  // Run algorithm.
114  algo.run(xpf, obj, true, *outStream);
115 
116  // Display number of function calls
117  ROL::printVectorFunctionCalls(xpf, *outStream);
118  }
119 
120  catch (std::logic_error err) {
121  *outStream << err.what() << "\n";
122  errorFlag = -1000;
123  }; // end try
124 
125  if (errorFlag != 0)
126  std::cout << "End Result: TEST FAILED\n";
127  else
128  std::cout << "End Result: TEST PASSED\n";
129 
130  return 0;
131 }
int OrdinalT
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.
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:80
Defines a no-output stream class ROL::NullStream and a function makeStreamPtr which either wraps a re...
Vector< Real > V
Provides the ROL::Vector interface for scalar values, to be used, for example, with scalar constraint...
Provides an interface to run optimization algorithms.
void printVectorFunctionCalls(const ProfiledVector< Ordinal, Real > &x, std::ostream &outStream=std::cout)
Contains definitions for the Zakharov function as evaluated using only the ROL::Vector interface...
By keeping a pointer to this in a derived Vector class, a tally of all methods is kept for profiling ...
basic_nullstream< char, char_traits< char >> nullstream
Definition: ROL_Stream.hpp:72
int main(int argc, char *argv[])