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