ROL
ROL_ConstraintFromObjective_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_CONSTRAINTFROMOBJECTIVE_DEF_H
45#define ROL_CONSTRAINTFROMOBJECTIVE_DEF_H
46
47namespace ROL {
48
49template<typename Real>
51 obj_(obj), dualVector_(nullPtr), offset_(offset), isDualInitialized_(false) {}
52
53template<typename Real>
54const Ptr<Objective<Real>> ConstraintFromObjective<Real>::getObjective(void) const { return obj_; }
55
56template<typename Real>
57void ConstraintFromObjective<Real>::setParameter( const std::vector<Real> &param ) {
58 obj_->setParameter(param);
60}
61
62template<typename Real>
64 obj_->update(x,type,iter);
65}
66
67template<typename Real>
68void ConstraintFromObjective<Real>::update( const Vector<Real>& x, bool flag, int iter ) {
69 obj_->update(x,flag,iter);
70}
71
72template<typename Real>
74 setValue(c, obj_->value(x,tol) - offset_ );
75}
76
77template<typename Real>
79 if ( !isDualInitialized_ ) {
80 dualVector_ = x.dual().clone();
81 isDualInitialized_ = true;
82 }
83 obj_->gradient(*dualVector_,x,tol);
84 //setValue(jv,v.dot(dualVector_->dual()));
85 setValue(jv,v.apply(*dualVector_));
86}
87
88template<typename Real>
90 obj_->gradient(ajv,x,tol);
91 ajv.scale(getValue(v));
92}
93
94template<typename Real>
96 obj_->hessVec(ahuv,v,x,tol);
97 ahuv.scale(getValue(u));
98}
99
100template<typename Real>
102 return dynamic_cast<const SingletonVector<Real>&>(x).getValue();
103}
104
105template<typename Real>
107 dynamic_cast<SingletonVector<Real>&>(x).setValue(val);
108}
109
110} // namespace ROL
111
112#endif // ROL_CONSTRAINTFROMOBJECTIVE_H
const Ptr< Obj > obj_
void setValue(Vector< Real > &x, Real val)
void update(const Vector< Real > &x, UpdateType type, int iter=-1) override
Update constraint function.
void value(Vector< Real > &c, const Vector< Real > &x, Real &tol) override
Evaluate the constraint operator at .
ConstraintFromObjective(const Ptr< Objective< Real > > &obj, const Real offset=0)
void applyAdjointHessian(Vector< Real > &ahuv, const Vector< Real > &u, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
Apply the derivative of the adjoint of the constraint Jacobian at to vector in direction ,...
void setParameter(const std::vector< Real > &param) override
const Ptr< Objective< Real > > getObjective(void) const
void applyAdjointJacobian(Vector< Real > &ajv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
Apply the adjoint of the the constraint Jacobian at , , to vector .
void applyJacobian(Vector< Real > &jv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
Apply the constraint Jacobian at , , to vector .
virtual void setParameter(const std::vector< Real > &param)
Provides the interface to evaluate objective functions.
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:84
virtual Real apply(const Vector< Real > &x) const
Apply to a dual vector. This is equivalent to the call .
Definition: ROL_Vector.hpp:238
virtual void scale(const Real alpha)=0
Compute where .
virtual const Vector & dual() const
Return dual representation of , for example, the result of applying a Riesz map, or change of basis,...
Definition: ROL_Vector.hpp:226
virtual ROL::Ptr< Vector > clone() const =0
Clone to make a new (uninitialized) vector.