ROL
ROL_BoundToConstraint.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_BOUND_TO_CONSTRAINT_H
45 #define ROL_BOUND_TO_CONSTRAINT_H
46 
47 #include "ROL_Constraint.hpp"
50 
56 namespace ROL {
57 
58 template <class Real>
59 class BoundToConstraint : public Constraint<Real> {
60 private:
61  ROL::Ptr<InequalityConstraint<Real> > lo_;
62  ROL::Ptr<InequalityConstraint<Real> > up_;
63  ROL::Ptr<Vector<Real> > tmp_;
64 
65 public:
67  lo_ = ROL::makePtr<LowerBoundToConstraint<Real>>(bnd,x);
68  up_ = ROL::makePtr<UpperBoundToConstraint<Real>>(bnd,x);
69  tmp_ = x.clone();
70  }
71 
73  lo_ = ROL::makePtr<LowerBoundToConstraint<Real>>(lo);
74  up_ = ROL::makePtr<UpperBoundToConstraint<Real>>(up);
75  tmp_ = lo.clone();
76  }
77 
78  void value(Vector<Real> &c, const Vector<Real> &x, Real &tol) {
79  Vector<Real> &c0 = *(dynamic_cast<PartitionedVector<Real>&>(c).get(0));
80  Vector<Real> &c1 = *(dynamic_cast<PartitionedVector<Real>&>(c).get(1));
81  lo_->value(c0,x,tol);
82  up_->value(c1,x,tol);
83  }
84 
85  void applyJacobian(Vector<Real> &jv, const Vector<Real> &v, const Vector<Real> &x, Real &tol) {
86  Vector<Real> &jv0 = *(dynamic_cast<PartitionedVector<Real>&>(jv).get(0));
87  Vector<Real> &jv1 = *(dynamic_cast<PartitionedVector<Real>&>(jv).get(1));
88  lo_->applyJacobian(jv0,v,x,tol);
89  up_->applyJacobian(jv1,v,x,tol);
90  }
91 
92  void applyAdjointJacobian(Vector<Real> &ajv, const Vector<Real> &v, const Vector<Real> &x, Real &tol) {
93  const Vector<Real> &v0 = *(dynamic_cast<const PartitionedVector<Real>&>(v).get(0));
94  const Vector<Real> &v1 = *(dynamic_cast<const PartitionedVector<Real>&>(v).get(1));
95  lo_->applyAdjointJacobian(ajv,v0,x,tol);
96  up_->applyAdjointJacobian(*tmp_,v1,x,tol);
97  ajv.plus(*tmp_);
98  }
99 
101  const Vector<Real> &x, Real &tol) {
102  ahuv.zero();
103  }
104 };
105 
106 }
107 
108 #endif
void applyAdjointJacobian(Vector< Real > &ajv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
Apply the adjoint of the the constraint Jacobian at , , to vector .
BoundToConstraint(const Vector< Real > &lo, const Vector< Real > &up)
virtual ROL::Ptr< Vector > clone() const =0
Clone to make a new (uninitialized) vector.
virtual void plus(const Vector &x)=0
Compute , where .
Defines the linear algebra of vector space on a generic partitioned vector.
Provides an implementation for bound constraints.
BoundToConstraint(BoundConstraint< Real > &bnd, const Vector< Real > &x)
ROL::Ptr< InequalityConstraint< Real > > up_
virtual void zero()
Set to zero vector.
Definition: ROL_Vector.hpp:167
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:80
void applyAdjointHessian(Vector< Real > &ahuv, const Vector< Real > &u, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
Apply the derivative of the adjoint of the constraint Jacobian at to vector in direction ...
Provides the interface to apply upper and lower bound constraints.
ROL::Ptr< Vector< Real > > tmp_
void applyJacobian(Vector< Real > &jv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
Apply the constraint Jacobian at , , to vector .
Defines the general constraint operator interface.
void value(Vector< Real > &c, const Vector< Real > &x, Real &tol)
Evaluate the constraint operator at .
ROL::Ptr< InequalityConstraint< Real > > lo_