ROL
ROL_AffineTransformConstraint_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_AFFINE_TRANSFORM_CONSTRAINT_DEF_H
45 #define ROL_AFFINE_TRANSFORM_CONSTRAINT_DEF_H
46 
47 namespace ROL {
48 
49 template<typename Real>
51  const Ptr<Constraint<Real>> &acon,
52  const Vector<Real> &range,
53  const Ptr<VectorController<Real>> &storage)
54  : con_(con), acon_(acon), storage_(storage) {
55  primal_ = range.clone();
56  Av_ = range.clone();
57  dual_ = range.dual().clone();
58  if (storage == nullPtr) storage_ = makePtr<VectorController<Real>>();
59 }
60 
61 template<typename Real>
63  const Ptr<LinearConstraint<Real>> &acon,
64  const Ptr<VectorController<Real>> &storage)
65  : con_(con), acon_(acon), storage_(storage) {
66  primal_ = acon->createRangeSpaceVector();
67  Av_ = acon->createRangeSpaceVector();
68  dual_ = primal_->dual().clone();
69  if (storage == nullPtr) storage_ = makePtr<VectorController<Real>>();
70 }
71 
72 template<typename Real>
74  const Ptr<const LinearOperator<Real>> &A,
75  const Ptr<const Vector<Real>> &b,
76  const Ptr<VectorController<Real>> &storage)
77  : con_(con), acon_(makePtr<LinearConstraint<Real>>(A,b)), storage_(storage) {
78  primal_ = b->clone();
79  Av_ = b->clone();
80  dual_ = b->dual().clone();
81  if (storage == nullPtr) storage_ = makePtr<VectorController<Real>>();
82 }
83 
84 template<typename Real>
86  storage_->constraintUpdate(type);
87  acon_->update(x,type,iter);
88  con_->update(*transform(x),type,iter);
89 }
90 
91 template<typename Real>
92 void AffineTransformConstraint<Real>::update( const Vector<Real> &x, bool flag, int iter ) {
93  storage_->constraintUpdate(true);
94  acon_->update(x,flag,iter);
95  con_->update(*transform(x),flag,iter);
96 }
97 
98 template<typename Real>
100  con_->value(c,*transform(x),tol);
101 }
102 
103 template<typename Real>
105  acon_->applyJacobian(*Av_,v,x,tol);
106  con_->applyJacobian(jv,*Av_,*transform(x),tol);
107 }
108 
109 template<typename Real>
111  con_->applyAdjointJacobian(*dual_,v,*transform(x),tol);
112  acon_->applyAdjointJacobian(ajv,*dual_,x,tol);
113 }
114 
115 template<typename Real>
117  acon_->applyJacobian(*Av_,v,x,tol);
118  con_->applyAdjointHessian(*dual_,u,*Av_,*transform(x),tol);
119  acon_->applyAdjointJacobian(ahuv,*dual_,x,tol);
120 }
121 
122 template<typename Real>
123 Ptr<const Vector<Real>> AffineTransformConstraint<Real>::transform(const Vector<Real> &x) {
124  bool isApplied = storage_->get(*primal_,Constraint<Real>::getParameter());
125  if (!isApplied) {
126  Real tol = std::sqrt(ROL_EPSILON<Real>());
127  acon_->value(*primal_,x,tol);
128  storage_->set(*primal_,Constraint<Real>::getParameter());
129  }
130  return primal_;
131 }
132 
133 } // namespace ROL
134 
135 #endif // ROL_AFFINE_TRANSFORM_OBJECTIVE_H
Defines the general affine constraint with the form .
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
Ptr< VectorController< Real > > storage_
virtual ROL::Ptr< Vector > clone() const =0
Clone to make a new (uninitialized) vector.
void applyJacobian(Vector< Real > &jv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
Apply the constraint Jacobian at , , to vector .
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:80
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 .
AffineTransformConstraint(const Ptr< Constraint< Real >> &con, const Ptr< Constraint< Real >> &acon, const Vector< Real > &range, const Ptr< VectorController< Real >> &storage=nullPtr)
Ptr< const Vector< Real > > transform(const Vector< Real > &x)
void update(const Vector< Real > &x, UpdateType type, int iter=-1) override
Update constraint function.
Provides the interface to apply a linear operator.
void value(Vector< Real > &c, const Vector< Real > &x, Real &tol) override
Evaluate the constraint operator at .
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 ...
Defines the general constraint operator interface.