ROL
ROL_DiagonalOperator.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_DIAGONALOPERATOR_H
45#define ROL_DIAGONALOPERATOR_H
46
47#include "ROL_Vector.hpp"
48#include "ROL_Elementwise_Function.hpp"
50
51
59namespace ROL {
60
61template<class Real>
62class DiagonalOperator : public LinearOperator<Real> {
63
64private:
65
66 ROL::Ptr<Vector<Real> > diag_;
67
68 const Elementwise::Multiply<Real> mult_;
69 const Elementwise::Divide<Real> div_;
70
71public:
72
73 DiagonalOperator( const Vector<Real> &diag ) : diag_(diag.clone()) {
74 diag_->set(diag);
75 }
76
77 void update( const Vector<Real> &x, bool flag = true, int iter = -1 ) {
78 diag_->set(x);
79 }
80
81 void apply( Vector<Real> &Hv, const Vector<Real> &v, Real &tol ) const {
82 Hv.set(v);
83 Hv.applyBinary( mult_, *diag_ );
84 }
85
86 void applyInverse( Vector<Real> &Hv, const Vector<Real> &v, Real &tol ) const {
87 Hv.set(v);
88 Hv.applyBinary( div_, *diag_ );
89 }
90
91};
92
93} // namespace ROL
94
95
96
97
98#endif // ROL_DIAGONALOPERATOR_H
99
Provides the interface to apply a diagonal operator which acts like elementwise multiplication when a...
ROL::Ptr< Vector< Real > > diag_
void update(const Vector< Real > &x, bool flag=true, int iter=-1)
Update linear operator.
void applyInverse(Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
Apply inverse of linear operator.
const Elementwise::Divide< Real > div_
DiagonalOperator(const Vector< Real > &diag)
const Elementwise::Multiply< Real > mult_
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
virtual void applyBinary(const Elementwise::BinaryFunction< Real > &f, const Vector &x)
Definition: ROL_Vector.hpp:248