ROL
ROL_LinearOperatorProduct.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_LINEAROPERATORPRODUCT_H
45#define ROL_LINEAROPERATORPRODUCT_H
46
48
56namespace ROL {
57
58template <class Real>
60
61 typedef Vector<Real> V;
63
64 typedef typename std::vector<ROL::Ptr<OP> >::size_type size_type;
65
66private:
67
68 ROL::Ptr<std::vector<ROL::Ptr<OP> > > ops_;
69
70public:
71
72 LinearOperatorSum( ROL::Ptr<OP> &A,
73 ROL::Ptr<OP> &B) {
74 ops_ = ROL::makePtr<std::vector<OP> >>();
75 ops_->push_back(A);
76 ops_->push_back(B);
77 }
78
79 LinearOperatorSum( ROL::Ptr<OP> &A,
80 ROL::Ptr<OP> &B,
81 ROL::Ptr<OP> &C) {
82 ops_ = ROL::makePtr<std::vector<OP> >>();
83 ops_->push_back(A);
84 ops_->push_back(B);
85 ops_->push_back(C);
86 }
87
88 virtual void update( const Vector<Real> &x, bool flag = true, int iter = -1 ) {
89 for( size_type i=0; i<ops_->size(); ++i ) {
90 (*ops_)[i]->update(x,flag,true);
91 }
92 }
93
94 virtual void apply( Vector<Real> &Hv, const Vector<Real> &v, Real &tol ) const {
95 Hv.set(v);
96 for( size_type i=0; i<ops_->size(); ++i ) {
97 (*ops_)[i]->apply(Hv,Hv,tol);
98 }
99 }
100
101 virtual void applyInverse( Vector<Real> &Hv, const Vector<Real> &v, Real &tol ) const {
102 Hv.set(v);
103 for( size_type i=ops_->size()-1; i>=0; --i ) {
104 (*ops_)[i]->applyInverse(Hv,Hv,tol);
105 }
106 }
107
108}; // class LinearOperatorProduct
109
110} // namespace ROL
111
112#endif // ROL_LINEAROPERATORPRODUCT_H
typename PV< Real >::size_type size_type
LinearOperatorSum(ROL::Ptr< OP > &A, ROL::Ptr< OP > &B)
ROL::Ptr< std::vector< ROL::Ptr< OP > > > ops_
std::vector< ROL::Ptr< OP > >::size_type size_type
virtual void update(const Vector< Real > &x, bool flag=true, int iter=-1)
Update linear operator.
virtual void applyInverse(Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
Apply inverse of linear operator.
LinearOperatorSum(ROL::Ptr< OP > &A, ROL::Ptr< OP > &B, ROL::Ptr< OP > &C)
virtual void apply(Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
Apply linear operator.
Provides the interface to apply a linear operator.
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:84
virtual void set(const Vector &x)
Set where .
Definition: ROL_Vector.hpp:209