ROL
rosenbrock/example_01.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 
49 #define USE_HESSVEC 1
50 
51 #include "ROL_Rosenbrock.hpp"
52 #include "ROL_Algorithm.hpp"
53 #include "ROL_LineSearchStep.hpp"
54 #include "ROL_StatusTest.hpp"
55 #include "ROL_Stream.hpp"
56 #include "Teuchos_GlobalMPISession.hpp"
57 
58 #include <iostream>
59 
60 typedef double RealT;
61 
62 int main(int argc, char *argv[]) {
63 
64  Teuchos::GlobalMPISession mpiSession(&argc, &argv);
65 
66  // This little trick lets us print to std::cout only if a (dummy) command-line argument is provided.
67  int iprint = argc - 1;
68  ROL::Ptr<std::ostream> outStream;
69  ROL::nullstream bhs; // outputs nothing
70  if (iprint > 0)
71  outStream = ROL::makePtrFromRef(std::cout);
72  else
73  outStream = ROL::makePtrFromRef(bhs);
74 
75  int errorFlag = 0;
76 
77  // *** Example body.
78 
79  try {
80 
82  int dim = 100; // Set problem dimension. Must be even.
83 
84  // Set parameters.
85  ROL::ParameterList parlist;
86  parlist.sublist("Step").sublist("Line Search").sublist("Descent Method").set("Type", "Newton-Krylov");
87  parlist.sublist("Status Test").set("Gradient Tolerance",1.e-12);
88  parlist.sublist("Status Test").set("Step Tolerance",1.e-14);
89  parlist.sublist("Status Test").set("Iteration Limit",100);
90 
91  // Define algorithm.
92  ROL::Algorithm<RealT> algo("Line Search",parlist);
93 
94  // Iteration Vector
95  ROL::Ptr<std::vector<RealT> > x_ptr = ROL::makePtr<std::vector<RealT>>(dim, 0.0);
96  // Set Initial Guess
97  for (int i=0; i<dim/2; i++) {
98  (*x_ptr)[2*i] = -1.2;
99  (*x_ptr)[2*i+1] = 1.0;
100  }
101  ROL::StdVector<RealT> x(x_ptr);
102 
103  // Run Algorithm
104  algo.run(x, obj, true, *outStream);
105 
106  // Get True Solution
107  ROL::Ptr<std::vector<RealT> > xtrue_ptr = ROL::makePtr<std::vector<RealT>>(dim, 1.0);
108  ROL::StdVector<RealT> xtrue(xtrue_ptr);
109 
110  // Compute Error
111  x.axpy(-1.0, xtrue);
112  RealT abserr = x.norm();
113  RealT relerr = abserr/xtrue.norm();
114  *outStream << std::scientific << "\n Absolute Error: " << abserr;
115  *outStream << std::scientific << "\n Relative Error: " << relerr << "\n";
116  if ( relerr > sqrt(ROL::ROL_EPSILON<RealT>()) ) {
117  errorFlag += 1;
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 
132 }
133 
RealT
double RealT
Definition: function/constraint/test_01.cpp:63
main
int main(int argc, char *argv[])
Definition: rosenbrock/example_01.cpp:62
ROL::StdVector::axpy
void axpy(const Real alpha, const Vector< Real > &x)
Compute where .
Definition: ROL_StdVector.hpp:101
RealT
double RealT
Definition: rosenbrock/example_01.cpp:60
ROL::StdVector::norm
Real norm() const
Returns where .
Definition: ROL_StdVector.hpp:138
TRIBITS_ADD_EXECUTABLE
TRIBITS_ADD_EXECUTABLE(example_01 SOURCES example_01.cpp ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE(example_02 SOURCES example_02.cpp ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE(example_03 SOURCES example_03.cpp ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE(example_04 SOURCES example_04.cpp ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE(example_05 SOURCES example_05.cpp ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE(example_06 SOURCES example_06.cpp ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE(example_07 SOURCES example_07.cpp ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE(example_08 SOURCES example_08.cpp ADD_DIR_TO_NAME) TRIBITS_COPY_FILES_TO_BINARY_DIR(BurgersControlDataCopy SOURCE_FILES input.xml SOURCE_DIR "$
Definition: example/burgers-control/CMakeLists.txt:3
ROL::details::nullstream
basic_nullstream< char, char_traits< char > > nullstream
Definition: ROL_Stream.hpp:72
ROL_LineSearchStep.hpp
ROL_Rosenbrock.hpp
Contains definitions for Rosenbrock's function.
TRIBITS_ADD_EXECUTABLE_AND_TEST
TRIBITS_ADD_EXECUTABLE_AND_TEST(FLETCHER SOURCES test_01.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(BOUNDFLETCHER SOURCES test_02.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(ALLPROBLEMS SOURCES test_03.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_COPY_FILES_TO_BINARY_DIR(StepFletcherTestDataCopy SOURCE_FILES input.xml input_ex02.xml input_ex03.xml SOURCE_DIR "$
Definition: test/step/fletcher/CMakeLists.txt:2
TRIBITS_ADD_EXECUTABLE_AND_TEST
TRIBITS_ADD_EXECUTABLE_AND_TEST(DerivativeCheck SOURCES test_01.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(BarrierFunctionCheck SOURCES test_02.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(BlockOperatorCheck SOURCES test_03.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(SimOptSolveCheck SOURCES test_04.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(NonlinearLeastSquaresCheck SOURCES test_05.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(StdObjectiveCheck SOURCES test_06.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(CompositeObjectiveCheck SOURCES test_07.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(CompositeObjectiveSimOptCheck SOURCES test_08.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(ConstraintPartionedCheck SOURCES test_09.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(CompositeConstraintCheck SOURCES test_10.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE(ColemanLiModelCheck SOURCES test_11.cpp ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(HouseholderReflectorCheck SOURCES test_12.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(BinaryConstraintCheck SOURCES test_13.cpp ARGS PrintItAll PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_COPY_FILES_TO_BINARY_DIR(BinaryConstraintDataCopy SOURCE_FILES binary_constraint.xml SOURCE_DIR "$
Definition: test/function/CMakeLists.txt:5
TRIBITS_ADD_EXECUTABLE_AND_TEST
TRIBITS_ADD_EXECUTABLE_AND_TEST(StdVectorInterface SOURCES test_01.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(PartitionedVectorInterface SOURCES test_04.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(ScaledStdVectorInterface SOURCES test_05.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(ProfiledVectorInterface SOURCES test_06.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(RieszVectorInterface SOURCES test_07.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(VectorCloneInterface SOURCES test_09.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE(VectorWorkspace SOURCES test_10.cpp ADD_DIR_TO_NAME) TRIBITS_COPY_FILES_TO_BINARY_DIR(VectorTestDataCopy SOURCE_FILES parameters.xml SOURCE_DIR "$
Definition: test/vector/CMakeLists.txt:2
TRIBITS_ADD_EXECUTABLE_AND_TEST
TRIBITS_ADD_EXECUTABLE_AND_TEST(LineSearch SOURCES test_01.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(TrustRegion SOURCES test_02.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(BoxConstrained_LineSearch SOURCES test_03.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(BoxConstrained_TrustRegion SOURCES test_04.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(BoxConstrained_PrimalDualActiveSet SOURCES test_05.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(LineSearchTypes SOURCES test_06.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(StepNotImplemented SOURCES test_12.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(InteriorPointStep SOURCES test_13.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(MoreauYosidaPenaltyStep SOURCES test_14.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(BoxConstrained_LM_TrustRegion SOURCES test_15.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(AugmentedLagrangianStep SOURCES test_16.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(FletcherStep SOURCES test_17.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_COPY_FILES_TO_BINARY_DIR(StepTestDataCopy SOURCE_FILES input.xml SOURCE_DIR "$
Definition: test/step/CMakeLists.txt:6
ROL::ZOO::Objective_Rosenbrock
Rosenbrock's function.
Definition: ROL_Rosenbrock.hpp:66
ROL_Algorithm.hpp
ROL_StatusTest.hpp
ROL::Algorithm
Provides an interface to run optimization algorithms.
Definition: ROL_Algorithm.hpp:72
ROL::Algorithm::run
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.
Definition: ROL_Algorithm.hpp:135
TRIBITS_ADD_EXECUTABLE_AND_TEST
TRIBITS_ADD_EXECUTABLE_AND_TEST(example_01 SOURCES example_01.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(example_02 SOURCES example_02.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_COPY_FILES_TO_BINARY_DIR(ZakharovDataCopy SOURCE_FILES parameters.xml SOURCE_DIR "$
Definition: example/zakharov/CMakeLists.txt:2
TRIBITS_ADD_EXECUTABLE_AND_TEST
TRIBITS_ADD_EXECUTABLE_AND_TEST(example_01 SOURCES example_01.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(example_02 SOURCES example_02.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_COPY_FILES_TO_BINARY_DIR(PoissonControlDataCopy SOURCE_FILES input.xml example_02.xml SOURCE_DIR "$
Definition: example/poisson-control/CMakeLists.txt:4
TRIBITS_ADD_EXECUTABLE_AND_TEST
TRIBITS_ADD_EXECUTABLE_AND_TEST(example_01 SOURCES example_01.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(example_02 SOURCES example_02.cpp ARGS "default" "exactsolve" NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_COPY_FILES_TO_BINARY_DIR(GrossPitaevskiiDataCopy SOURCE_FILES parameters.xml SOURCE_DIR "$
Definition: example/gross-pitaevskii/CMakeLists.txt:3
include_directories
include_directories(${JSONCPP_INCLUDE_DIRS}) TRIBITS_ADD_EXECUTABLE_AND_TEST(example_01 SOURCES example_01.cpp IMPORTEDLIBS jsoncpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_COPY_FILES_TO_BINARY_DIR(JsonDataCopy SOURCE_FILES parameters.json SOURCE_DIR "$
Definition: example/json/CMakeLists.txt:15
TRIBITS_ADD_EXECUTABLE_AND_TEST
TRIBITS_ADD_EXECUTABLE_AND_TEST(example_01a SOURCES example_01a.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(example_01b SOURCES example_01b.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_ADD_EXECUTABLE_AND_TEST(example_02 SOURCES example_02.cpp ARGS PrintItAll NUM_MPI_PROCS 1 PASS_REGULAR_EXPRESSION "TEST PASSED" ADD_DIR_TO_NAME) TRIBITS_COPY_FILES_TO_BINARY_DIR(SacadoDataCopy SOURCE_FILES parameters.xml SOURCE_DIR "$
Definition: example/sacado/CMakeLists.txt:5
ROL::StdVector
Provides the ROL::Vector interface for scalar values, to be used, for example, with scalar constraint...
Definition: ROL_StdVector.hpp:60
MINRES
Implements the MINRES algorithm for solving symmetric indefinite systems.
VectorWorkspace
Provides a "smart" cloning manager to be used a member variable in a class and called in the member f...
ROL_Stream.hpp
Defines a no-output stream class ROL::NullStream and a function makeStreamPtr which either wraps a re...