ROL
ROL_BinaryConstraint_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_BINARY_CONSTRAINT_DEF_H
45 #define ROL_BINARY_CONSTRAINT_DEF_H
46 
47 namespace ROL {
48 
49 template<typename Real>
51  const ROL::Ptr<const Vector<Real>> &up, Real gamma ) :
52  lo_(lo), up_(up), d_(lo_->clone()), gamma_(gamma) {}
53 
54 template<typename Real>
56  BinaryConstraint( bnd.getLowerBound(), bnd.getUpperBound(), gamma ) {}
57 
58 template<typename Real>
59 BinaryConstraint<Real>::BinaryConstraint( const ROL::Ptr<const BoundConstraint<Real>> &bnd, Real gamma ) :
60  BinaryConstraint( bnd->getLowerBound(), bnd->getUpperBound(), gamma ) {}
61 
62 template<typename Real>
64  const Real one(1);
65  c.set( x );
66  c.axpy( -one, *lo_ ); // c = x-l
67  d_->set( *up_ );
68  d_->axpy( -one, x ); // d = u-x
69  c.applyBinary(BoundsCheck(0), *d_ );
70  c.scale( gamma_ );
71 }
72 
73 template<typename Real>
75  const Real one(1);
76  jv.set( x );
77  jv.axpy( -one, *lo_ );
78  d_->set( *up_ );
79  d_->axpy( -one, x );
80  jv.applyBinary( BoundsCheck(1), *d_ );
81  jv.applyBinary( Elementwise::Multiply<Real>(), v );
82  jv.scale( gamma_ );
83 }
84 
85 template<typename Real>
87  applyJacobian(ajv,v,x,tol);
88 }
89 
90 template<typename Real>
92  const Real one(1);
93  ahuv.set( x );
94  ahuv.axpy( -one, *lo_ );
95  d_->set( *up_ );
96  d_->axpy( -one, x );
97  ahuv.applyBinary( BoundsCheck(2), *d_ );
98  ahuv.applyBinary( Elementwise::Multiply<Real>(), v );
99  ahuv.applyBinary( Elementwise::Multiply<Real>(), u );
100  ahuv.scale( gamma_ );
101 }
102 
103 template<typename Real>
105  gamma_ = gamma;
106 }
107 
108 } // namespace ROL
109 
110 #endif // ROL_BINARY_CONSTRAINT_DEF_H
virtual void scale(const Real alpha)=0
Compute where .
Implements an equality constraint function that evaluates to zero on the surface of a bounded paralle...
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 ...
virtual void axpy(const Real alpha, const Vector &x)
Compute where .
Definition: ROL_Vector.hpp:153
virtual void applyBinary(const Elementwise::BinaryFunction< Real > &f, const Vector &x)
Definition: ROL_Vector.hpp:248
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:80
void applyJacobian(ROL::Vector< Real > &jv, const ROL::Vector< Real > &v, const ROL::Vector< Real > &sol)
void applyJacobian(Vector< Real > &jv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
Apply the constraint Jacobian at , , to vector .
BinaryConstraint(const ROL::Ptr< const Vector< Real >> &lo, const ROL::Ptr< const Vector< Real >> &up, Real gamma)
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 .
Provides the interface to apply upper and lower bound constraints.
virtual void set(const Vector &x)
Set where .
Definition: ROL_Vector.hpp:209
void value(Vector< Real > &c, const Vector< Real > &x, Real &tol) override
Evaluate the constraint operator at .