ROL
ROL_DaiFletcherProjection.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 
45 #ifndef ROL_DAIFLETCHERPROJECTION_H
46 #define ROL_DAIFLETCHERPROJECTION_H
47 
49 #include "ROL_ParameterList.hpp"
50 
51 namespace ROL {
52 
53 template<typename Real>
55 private:
56  int dim_;
57  Ptr<Vector<Real>> xnew_, Px_;
58  Real b_, mul1_, dlam1_, cdot_;
59 
62 
63  Real atol_, rtol_, ltol_;
65 
66  Real ctol_;
67 
74 
75  void initialize(const Vector<Real> &xprim,
76  const Vector<Real> &xdual,
77  const Ptr<BoundConstraint<Real>> &bnd,
78  const Ptr<Constraint<Real>> &con,
79  const Vector<Real> &mul,
80  const Vector<Real> &res);
81 
82 public:
83 
85  const Vector<Real> &xdual,
86  const Ptr<BoundConstraint<Real>> &bnd,
87  const Ptr<Constraint<Real>> &con,
88  const Vector<Real> &mul,
89  const Vector<Real> &res);
90 
92  const Vector<Real> &xdual,
93  const Ptr<BoundConstraint<Real>> &bnd,
94  const Ptr<Constraint<Real>> &con,
95  const Vector<Real> &mul,
96  const Vector<Real> &res,
97  ParameterList &list);
98 
99  void project(Vector<Real> &x, std::ostream &stream = std::cout) override;
100 
101 private:
102 
103  Real residual(const Vector<Real> &x) const;
104 
105  void update_primal(Vector<Real> &y, const Vector<Real> &x, const Real lam) const;
106 
107  void project_df(Vector<Real> &x, Real &lam, Real &dlam, std::ostream &stream = std::cout) const;
108 
109 }; // class DaiFletcherProjection
110 
111 } // namespace ROL
112 
114 
115 #endif
Real residual(const Vector< Real > &x) const
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:80
DaiFletcherProjection(const Vector< Real > &xprim, const Vector< Real > &xdual, const Ptr< BoundConstraint< Real >> &bnd, const Ptr< Constraint< Real >> &con, const Vector< Real > &mul, const Vector< Real > &res)
void project(Vector< Real > &x, std::ostream &stream=std::cout) override
void initialize(const Vector< Real > &xprim, const Vector< Real > &xdual, const Ptr< BoundConstraint< Real >> &bnd, const Ptr< Constraint< Real >> &con, const Vector< Real > &mul, const Vector< Real > &res)
void project_df(Vector< Real > &x, Real &lam, Real &dlam, std::ostream &stream=std::cout) const
void update_primal(Vector< Real > &y, const Vector< Real > &x, const Real lam) const
Provides the interface to apply upper and lower bound constraints.
Defines the general constraint operator interface.