ROL
ROL_SlacklessObjective_Def.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_SLACKLESSOBJECTIVE_DEF_HPP
45#define ROL_SLACKLESSOBJECTIVE_DEF_HPP
46
47namespace ROL {
48
49template<typename Real>
51
52template<typename Real>
53Ptr<Objective<Real>> SlacklessObjective<Real>::getObjective(void) const {
54 return obj_;
55}
56
57template<typename Real>
59 obj_->update( *getOpt(x), type, iter );
60}
61
62template<typename Real>
63void SlacklessObjective<Real>::update( const Vector<Real> &x, bool flag, int iter ) {
64 obj_->update( *getOpt(x), flag, iter );
65}
66
67template<typename Real>
68Real SlacklessObjective<Real>::value( const Vector<Real> &x, Real &tol ) {
69 return obj_->value( *getOpt(x), tol );
70}
71
72template<typename Real>
73Real SlacklessObjective<Real>::dirDeriv( const Vector<Real> &x, const Vector<Real> &d, Real &tol ) {
74 return obj_->dirDeriv(*getOpt(x),*getOpt(d),tol);
75}
76
77template<typename Real>
79 zeroSlack(g);
80 obj_->gradient(*getOpt(g),*getOpt(x),tol);
81}
82
83template<typename Real>
84void SlacklessObjective<Real>::hessVec( Vector<Real> &hv, const Vector<Real> &v, const Vector<Real> &x, Real &tol ) {
85 zeroSlack(hv);
86 obj_->hessVec(*getOpt(hv),*getOpt(v),*getOpt(x),tol);
87}
88
89template<typename Real>
91 obj_->invHessVec( *getOpt(ihv), *getOpt(v), *getOpt(x), tol );
92 PartitionedVector<Real> &Pvp = dynamic_cast<PartitionedVector<Real>&>(ihv);
93 const PartitionedVector<Real> &vp = dynamic_cast<const PartitionedVector<Real>&>(v);
94 const int nvec = static_cast<int>(vp.numVectors());
95 for (int i = 1; i < nvec; ++i) {
96 Pvp.get(i)->set(vp.get(i)->dual());
97 }
98}
99
100template<typename Real>
102 obj_->precond( *getOpt(Pv), *getOpt(v), *getOpt(x), tol );
103 PartitionedVector<Real> &Pvp = dynamic_cast<PartitionedVector<Real>&>(Pv);
104 const PartitionedVector<Real> &vp = dynamic_cast<const PartitionedVector<Real>&>(v);
105 const int nvec = static_cast<int>(vp.numVectors());
106 for (int i = 1; i < nvec; ++i) {
107 Pvp.get(i)->set(vp.get(i)->dual());
108 }
109}
110
111template<typename Real>
112void SlacklessObjective<Real>::setParameter(const std::vector<Real> &param) {
114 obj_->setParameter(param);
115}
116
117template<typename Real>
118Ptr<Vector<Real>> SlacklessObjective<Real>::getOpt( Vector<Real> &xs ) const {
119 return dynamic_cast<PartitionedVector<Real>&>(xs).get(0);
120}
121
122template<typename Real>
123Ptr<const Vector<Real>> SlacklessObjective<Real>::getOpt( const Vector<Real> &xs ) const {
124 return dynamic_cast<const PartitionedVector<Real>&>(xs).get(0);
125}
126
127template<typename Real>
130 = dynamic_cast<PartitionedVector<Real>&>(x);
131 const int nvec = static_cast<int>(xpv.numVectors());
132 for (int i = 1; i < nvec; ++i) {
133 xpv.get(i)->zero();
134 }
135}
136
137} // namespace ROL
138
139#endif // ROL__SLACKLESSOBJECTIVE_HPP
140
const Ptr< Obj > obj_
Provides the interface to evaluate objective functions.
virtual void setParameter(const std::vector< Real > &param)
Defines the linear algebra of vector space on a generic partitioned vector.
ROL::Ptr< const Vector< Real > > get(size_type i) const
Real value(const Vector< Real > &x, Real &tol) override
Compute value.
SlacklessObjective(const Ptr< Objective< Real > > &obj)
void invHessVec(Vector< Real > &ihv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
Apply inverse Hessian approximation to vector.
void gradient(Vector< Real > &g, const Vector< Real > &x, Real &tol) override
Compute gradient.
void setParameter(const std::vector< Real > &param) override
Real dirDeriv(const Vector< Real > &x, const Vector< Real > &d, Real &tol) override
Compute directional derivative.
void update(const Vector< Real > &x, UpdateType type, int iter=-1) override
Update objective function.
void precond(Vector< Real > &Pv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
Apply preconditioner to vector.
Ptr< Objective< Real > > getObjective(void) const
Ptr< Vector< Real > > getOpt(Vector< Real > &xs) const
void zeroSlack(Vector< Real > &x) const
void hessVec(Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
Apply Hessian approximation to vector.
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:84