ROL
ROL_PolyhedralProjection_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
45#ifndef ROL_POLYHEDRALPROJECTION_DEF_H
46#define ROL_POLYHEDRALPROJECTION_DEF_H
47
48namespace ROL {
49
50template<typename Real>
52 : bnd_(bnd), con_(nullPtr) {}
53
54template<typename Real>
56 const Vector<Real> &xdual,
57 const Ptr<BoundConstraint<Real>> &bnd,
58 const Ptr<Constraint<Real>> &con,
59 const Vector<Real> &mul,
60 const Vector<Real> &res)
61 : bnd_(bnd), con_(con) {
62 xprim_ = xprim.clone();
63 xdual_ = xdual.clone();
64 mul_ = mul.clone();
65 res_ = res.clone();
66}
67
68template<typename Real>
69void PolyhedralProjection<Real>::project(Vector<Real> &x, std::ostream &stream) {
70 if (con_ == nullPtr) {
71 bnd_->project(x);
72 }
73 else {
74 throw Exception::NotImplemented(">>> ROL::PolyhedralProjection::project : No projection implemented!");
75 }
76}
77
78template<typename Real>
79const Ptr<Constraint<Real>> PolyhedralProjection<Real>::getLinearConstraint(void) const {
80 return con_;
81}
82
83template<typename Real>
84const Ptr<BoundConstraint<Real>> PolyhedralProjection<Real>::getBoundConstraint(void) const {
85 return bnd_;
86}
87
88template<typename Real>
89const Ptr<Vector<Real>> PolyhedralProjection<Real>::getMultiplier(void) const {
90 return mul_;
91}
92
93template<typename Real>
94const Ptr<Vector<Real>> PolyhedralProjection<Real>::getResidual(void) const {
95 return res_;
96}
97
98} // namespace ROL
99
100#endif
Provides the interface to apply upper and lower bound constraints.
Defines the general constraint operator interface.
const Ptr< BoundConstraint< Real > > getBoundConstraint(void) const
virtual void project(Vector< Real > &x, std::ostream &stream=std::cout)
const Ptr< Vector< Real > > getResidual(void) const
const Ptr< Vector< Real > > getMultiplier(void) const
PolyhedralProjection(const Ptr< BoundConstraint< Real > > &bnd)
const Ptr< Constraint< Real > > getLinearConstraint(void) const
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:84
virtual ROL::Ptr< Vector > clone() const =0
Clone to make a new (uninitialized) vector.