ROL
ROL_LinearObjective_SimOpt.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
44#ifndef ROL_LINEAR_OBJECTIVE_SIMOPT_H
45#define ROL_LINEAR_OBJECTIVE_SIMOPT_H
46
48
63namespace ROL {
64
65template <class Real>
67private:
68 const Ptr<const Vector<Real>> simcost_, optcost_;
69
70public:
71 LinearObjective_SimOpt(const Ptr<const Vector<Real>> &simcost = nullPtr,
72 const Ptr<const Vector<Real>> &optcost = nullPtr)
73 : simcost_(simcost), optcost_(optcost) {}
74
75 Real value( const Vector<Real> &u, const Vector<Real> &z, Real &tol ) {
76 Real valu(0), valz(0);
77 if (simcost_ != nullPtr) {
78 //valu = u.dot(simcost_->dual());
79 valu = u.apply(*simcost_);
80 }
81 if (optcost_ != nullPtr) {
82 //valz = z.dot(optcost_->dual());
83 valz = z.apply(*optcost_);
84 }
85 return valu + valz;
86 }
87
88 void gradient_1( Vector<Real> &g, const Vector<Real> &u, const Vector<Real> &z, Real &tol ) {
89 if (simcost_ != nullPtr) {
90 g.set(*simcost_);
91 }
92 else {
93 g.zero();
94 }
95 }
96
97 void gradient_2( Vector<Real> &g, const Vector<Real> &u, const Vector<Real> &z, Real &tol ) {
98 if (optcost_ != nullPtr) {
99 g.set(*optcost_);
100 }
101 else {
102 g.zero();
103 }
104 }
105
106 void hessVec_11( Vector<Real> &hv, const Vector<Real> &v, const Vector<Real> &u, const Vector<Real> &z, Real &tol ) {
107 hv.zero();
108 }
109
110 void hessVec_12( Vector<Real> &hv, const Vector<Real> &v, const Vector<Real> &u, const Vector<Real> &z, Real &tol ) {
111 hv.zero();
112 }
113
114 void hessVec_21( Vector<Real> &hv, const Vector<Real> &v, const Vector<Real> &u, const Vector<Real> &z, Real &tol ) {
115 hv.zero();
116 }
117
118 void hessVec_22( Vector<Real> &hv, const Vector<Real> &v, const Vector<Real> &u, const Vector<Real> &z, Real &tol ) {
119 hv.zero();
120 }
121
122}; // class LinearObjective_SimOpt
123
124} // namespace ROL
125
126#endif
Provides the interface to evaluate linear objective functions.
LinearObjective_SimOpt(const Ptr< const Vector< Real > > &simcost=nullPtr, const Ptr< const Vector< Real > > &optcost=nullPtr)
const Ptr< const Vector< Real > > simcost_
void hessVec_12(Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
void hessVec_11(Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
Apply Hessian approximation to vector.
void hessVec_22(Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
Real value(const Vector< Real > &u, const Vector< Real > &z, Real &tol)
Compute value.
void gradient_1(Vector< Real > &g, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
Compute gradient with respect to first component.
void gradient_2(Vector< Real > &g, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
Compute gradient with respect to second component.
const Ptr< const Vector< Real > > optcost_
void hessVec_21(Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
Provides the interface to evaluate simulation-based objective functions.
Defines the linear algebra or vector space interface.
virtual Real apply(const Vector< Real > &x) const
Apply to a dual vector. This is equivalent to the call .
virtual void set(const Vector &x)
Set where .
virtual void zero()
Set to zero vector.