ROL
ROL_LinearConstraint.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 #include "ROL_Constraint.hpp"
45 #include "ROL_LinearOperator.hpp"
46 
47 
48 #ifndef ROL_LINEAR_CONSTRAINT_H
49 #define ROL_LINEAR_CONSTRAINT_H
50 
51 
66 namespace ROL {
67 
68 template <class Real>
69 class LinearConstraint : public Constraint<Real> {
70 private:
71  const ROL::Ptr<const LinearOperator<Real>> A_;
72  const ROL::Ptr<const LinearOperator<Real>> Atrans_;
73  const ROL::Ptr<const Vector<Real>> b_;
75 public:
76  // Nonsymmetric case
77  LinearConstraint( const ROL::Ptr<const LinearOperator<Real>> &A,
78  const ROL::Ptr<const LinearOperator<Real>> &Atrans,
79  const ROL::Ptr<const Vector<Real> &b ) :
80  A_(A), Atrans_(Atrans), b_(b), isSymmetric_(false) {
81  }
82  // Symmetric case
83  LinearConstraint( const ROL::Ptr<const LinearOperator<Real>> &A,
84  const ROL::Ptr<const Vector<Real> &b ) :
85  A_(A), Atrans_(A), b_(b), isSymmetric_(true) {
86  }
87 
88  void value(Vector<Real> &c, const Vector<Real> &x, Real &tol) {
89  A_->apply(c,x,tol);
90  c_->axpy(-1.0,*b_);
91  }
92 
94  const Vector<Real> &x, Real &tol) {
95  A_->apply(jv,v,tol);
96  }
97 
99  const Vector<Real> &x, Real &tol) {
100  Atrans_->apply(ajv,v,tol);
101  }
102 
104  const Vector<Real> &x, Real &tol) {
105  ahuv.zero();
106  }
107 
108  void update( const Vector<Real> &x, bool flag = true, int iter = -1 ) {
109  A_->update(x,flag,iter);
110  if( !isSymmetric_ ) {
111  A_->update(x,flag,iter);
112  }
113  }
114 }; // class LinearConstraint
115 
116 
117 } // namespace ROL
118 
119 #endif //ROL_LINEAR_EQUALITY_CONSTRAINT_H
const ROL::Ptr< const LinearOperator< Real > > A_
Provides the interface to evaluate linear constraints.
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 ...
void update(const Vector< Real > &x, bool flag=true, int iter=-1)
Update constraint functions. x is the optimization variable, flag = true if optimization variable is ...
const ROL::Ptr< const Vector< Real > > b_
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 .
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 applyJacobian(Vector< Real > &jv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
Apply the constraint Jacobian at , , to vector .
LinearConstraint(const ROL::Ptr< const LinearOperator< Real >> &A, const ROL::Ptr< const LinearOperator< Real >> &Atrans, const ROL::Ptr< const Vector< Real > &b)
Provides the interface to apply a linear operator.
LinearConstraint(const ROL::Ptr< const LinearOperator< Real >> &A, const ROL::Ptr< const Vector< Real > &b)
void value(Vector< Real > &c, const Vector< Real > &x, Real &tol)
Evaluate the constraint operator at .
Defines the general constraint operator interface.
const ROL::Ptr< const LinearOperator< Real > > Atrans_