ROL
ROL_HS4.hpp
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 #ifndef USE_HESSVEC
50 #define USE_HESSVEC 1
51 #endif
52 
53 #ifndef ROL_HS4_HPP
54 #define ROL_HS4_HPP
55 
56 #include "ROL_StdVector.hpp"
57 #include "ROL_Objective.hpp"
58 #include "ROL_BoundConstraint.hpp"
59 #include "ROL_Types.hpp"
60 
61 namespace ROL {
62 namespace ZOO {
63 
66  template<class Real>
67  class Objective_HS4 : public Objective<Real> {
68 
69  typedef std::vector<Real> vector;
70  typedef Vector<Real> V;
72 
73  private:
74 
75  Teuchos::RCP<const vector> getVector( const V& x ) {
76  using Teuchos::dyn_cast;
77  return dyn_cast<const SV>(x).getVector();
78  }
79 
80  Teuchos::RCP<vector> getVector( V& x ) {
81  using Teuchos::dyn_cast;
82  return dyn_cast<SV>(x).getVector();
83  }
84 
85  public:
86  Objective_HS4(void) {}
87 
88  Real value( const Vector<Real> &x, Real &tol ) {
89  using Teuchos::RCP;
90  RCP<const vector> ex = getVector(x);
91 
92  return 1.0/3.0 * std::pow((*ex)[0] + 1.0,3.0) + (*ex)[1];
93  }
94 
95  void gradient( Vector<Real> &g, const Vector<Real> &x, Real &tol ) {
96  using Teuchos::RCP;
97  RCP<const vector> ex = getVector(x);
98  RCP<vector> eg = getVector(g);
99 
100  (*eg)[0] = std::pow((*ex)[0] + 1.0,2.0);
101  (*eg)[1] = 1.0;
102  }
103 #if USE_HESSVEC
104  void hessVec( Vector<Real> &hv, const Vector<Real> &v, const Vector<Real> &x, Real &tol ) {
105  using Teuchos::RCP;
106  RCP<const vector> ex = getVector(x);
107  RCP<const vector> ev = getVector(v);
108  RCP<vector> ehv = getVector(hv);
109 
110  Real alpha = 0.0;
111  (*ehv)[0] = 2.0*((*ex)[0] + 1.0)*(*ev)[0] + alpha*(*ev)[0];
112  (*ehv)[1] = 0.0 + alpha*(*ev)[1];
113  }
114 #endif
115  };
116 
117  template<class Real>
118  void getHS4( Teuchos::RCP<Objective<Real> > &obj, Teuchos::RCP<BoundConstraint<Real> > &con,
119  Vector<Real> &x0, Vector<Real> &x ) {
120 
121  typedef std::vector<Real> vector;
122  typedef Vector<Real> V;
123  typedef StdVector<Real> SV;
124  using Teuchos::RCP;
125  using Teuchos::rcp;
126  using Teuchos::dyn_cast;
127 
128  // Cast Initial Guess and Solution Vectors
129  RCP<vector> x0p = dyn_cast<SV>(x0).getVector();
130  RCP<vector> xp = dyn_cast<SV>(x).getVector();
131 
132  int n = xp->size();
133  // Resize Vectors
134  n = 2;
135  x0p->resize(n);
136  xp->resize(n);
137  // Instantiate Objective Function
138  obj = rcp( new Objective_HS4<Real> );
139 
140  // Instantiate BoundConstraint
141  RCP<vector> l_rcp = rcp( new vector(n,0.0) );
142  RCP<vector> u_rcp = rcp( new vector(n,0.0) );
143 
144  (*l_rcp)[0] = 1.0;
145  (*l_rcp)[1] = 0.0;
146  (*u_rcp)[0] = 0.1*ROL_OVERFLOW;
147  (*u_rcp)[1] = 0.1*ROL_OVERFLOW;
148 
149  RCP<V> l = rcp( new SV(l_rcp) );
150  RCP<V> u = rcp( new SV(u_rcp) );
151 
152  con = rcp( new BoundConstraint<Real>(l,u) );
153 
154  // Get Initial Guess
155  (*x0p)[0] = 1.125;
156  (*x0p)[1] = 0.125;
157  // Get Solution
158  (*xp)[0] = 1.0;
159  (*xp)[1] = 0.0;
160  }
161 
162 
163 } // End ZOO Namespace
164 } // End ROL Namespace
165 
166 #endif
Provides the interface to evaluate objective functions.
std::vector< Real > vector
Definition: ROL_HS4.hpp:69
virtual void hessVec(Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
Apply Hessian approximation to vector.
Contains definitions of custom data types in ROL.
void gradient(Vector< Real > &g, const Vector< Real > &x, Real &tol)
Compute gradient.
Definition: ROL_HS4.hpp:95
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:74
StdVector< Real > SV
Definition: ROL_HS4.hpp:71
Provides the std::vector implementation of the ROL::Vector interface.
void getHS4(Teuchos::RCP< Objective< Real > > &obj, Teuchos::RCP< BoundConstraint< Real > > &con, Vector< Real > &x0, Vector< Real > &x)
Definition: ROL_HS4.hpp:118
Real value(const Vector< Real > &x, Real &tol)
Compute value.
Definition: ROL_HS4.hpp:88
Provides the interface to apply upper and lower bound constraints.
Teuchos::RCP< const vector > getVector(const V &x)
Definition: ROL_HS4.hpp:75
W. Hock and K. Schittkowski 4th test function.
Definition: ROL_HS4.hpp:67
static const double ROL_OVERFLOW
Platform-dependent maximum double.
Definition: ROL_Types.hpp:126
Teuchos::RCP< vector > getVector(V &x)
Definition: ROL_HS4.hpp:80
Vector< Real > V
Definition: ROL_HS4.hpp:70