ROL
ROL_DyadicOperator.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_DYADICOPERATOR_H
45#define ROL_DYADICOPERATOR_H
46
48
49
55namespace ROL {
56
57// Implementation of a Dyadic operator x*y'
58template<class Real>
59class DyadicOperator : public ROL::LinearOperator<Real> {
60
62
63private:
64
65 const ROL::Ptr<const V> x_;
66 const ROL::Ptr<const V> y_;
67
68public:
69
70 DyadicOperator( const ROL::Ptr<const V> &x,
71 const ROL::Ptr<const V> &y ) : x_(x), y_(y) {}
72
73 void apply( V &Hv, const V &v, Real &tol ) const {
74 Hv.set(*x_);
75 Hv.scale(v.dot(*y_));
76 }
77
78 void applyInverse( V &Hv, const V &v, Real &tol ) const {
79
80 ROL_TEST_FOR_EXCEPTION( true , std::logic_error,
81 ">>> ERROR (ROL_DyadicOperator, applyInverse): "
82 "Not implemented.");
83
84 }
85}; // class DyadicOperator
86
87} // namespace ROL
88
89
90
91
92#endif // ROL_NULLOPERATOR_H
93
Interface to apply a dyadic operator to a vector.
void applyInverse(V &Hv, const V &v, Real &tol) const
Apply inverse of linear operator.
const ROL::Ptr< const V > x_
void apply(V &Hv, const V &v, Real &tol) const
Apply linear operator.
const ROL::Ptr< const V > y_
ROL::Vector< Real > V
DyadicOperator(const ROL::Ptr< const V > &x, const ROL::Ptr< const V > &y)
Provides the interface to apply a linear operator.
Defines the linear algebra or vector space interface.
virtual void set(const Vector &x)
Set where .
virtual void scale(const Real alpha)=0
Compute where .
virtual Real dot(const Vector &x) const =0
Compute where .