ROL
step/test_12.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 
50 #include "Teuchos_GlobalMPISession.hpp"
51 
52 #include "ROL_Step.hpp"
53 #include "ROL_GetTestProblems.hpp"
54 
55 #include <iostream>
56 
57 typedef double RealT;
58 
59 int main(int argc, char *argv[]) {
60 
61  Teuchos::GlobalMPISession mpiSession(&argc, &argv);
62 
63  // This little trick lets us print to std::cout only if a (dummy) command-line argument is provided.
64  int iprint = argc - 1;
65  ROL::Ptr<std::ostream> outStream;
66  ROL::nullstream bhs; // outputs nothing
67  if (iprint > 0)
68  outStream = ROL::makePtrFromRef(std::cout);
69  else
70  outStream = ROL::makePtrFromRef(bhs);
71 
72  int errorFlag = 0;
73  ROL::Ptr<ROL::Vector<RealT> > x0;
74  std::vector<ROL::Ptr<ROL::Vector<RealT> > > x;
75  ROL::Ptr<ROL::OptimizationProblem<RealT> > problem;
76  ROL::GetTestProblem<RealT>(problem,x0,x,ROL::TESTOPTPROBLEM_HS1);
77  ROL::Ptr<ROL::Objective<RealT> > obj = problem->getObjective();
78  ROL::Ptr<ROL::BoundConstraint<RealT> > bnd = problem->getBoundConstraint();
79  ROL::AlgorithmState<RealT> algo_state;
80 
81  // *** Test body.
82  ROL::Step<RealT> step;
83  int thrown = 0;
84  try {
85  try {
86  step.compute(*x0,*x[0],*obj,*bnd,algo_state);
87  }
88  catch (ROL::Exception::NotImplemented exc) {
89  *outStream << exc.what() << std::endl;
90  thrown++;
91  };
92  try {
93  step.update(*x0,*x[0],*obj,*bnd,algo_state);
94  }
95  catch (ROL::Exception::NotImplemented exc) {
96  *outStream << exc.what() << std::endl;
97  thrown++;
98  };
99  try {
100  step.printName();
101  }
102  catch (ROL::Exception::NotImplemented exc) {
103  *outStream << exc.what() << std::endl;
104  thrown++;
105  };
106  try {
107  step.printHeader();
108  }
109  catch (ROL::Exception::NotImplemented exc) {
110  *outStream << exc.what() << std::endl;
111  thrown++;
112  };
113  try {
114  step.print(algo_state,true);
115  }
116  catch (ROL::Exception::NotImplemented exc) {
117  *outStream << exc.what() << std::endl;
118  thrown++;
119  };
120  errorFlag = (thrown==5) ? 0 : 1;
121  }
122  catch (std::logic_error err) {
123  *outStream << err.what() << std::endl;
124  errorFlag = -1000;
125  }; // end try
126 
127  if (errorFlag != 0)
128  std::cout << "End Result: TEST FAILED" << std::endl;
129  else
130  std::cout << "End Result: TEST PASSED" << std::endl;
131 
132  return 0;
133 
134 }
135 
virtual void update(Vector< Real > &x, const Vector< Real > &s, Objective< Real > &obj, BoundConstraint< Real > &bnd, AlgorithmState< Real > &algo_state)
Update step, if successful.
Definition: ROL_Step.hpp:152
virtual std::string printHeader(void) const
Print iterate header.
Definition: ROL_Step.hpp:275
Provides the interface to compute optimization steps.
Definition: ROL_Step.hpp:69
Contains definitions of test objective functions.
virtual std::string print(AlgorithmState< Real > &algo_state, bool printHeader=false) const
Print iterate status.
Definition: ROL_Step.hpp:287
State for algorithm class. Will be used for restarts.
Definition: ROL_Types.hpp:143
virtual void compute(Vector< Real > &s, const Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &bnd, AlgorithmState< Real > &algo_state)
Compute step.
Definition: ROL_Step.hpp:144
basic_nullstream< char, char_traits< char >> nullstream
Definition: ROL_Stream.hpp:72
int main(int argc, char *argv[])
virtual std::string printName(void) const
Print step name.
Definition: ROL_Step.hpp:281