ROL_LinearOperator.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//               Rapid Optimization Library (ROL) Package
//
// Copyright 2014 NTESS and the ROL contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef ROL_LINEAROPERATOR_H
#define ROL_LINEAROPERATOR_H

#include "ROL_Vector.hpp"

namespace ROL {

template <class Real>
class LinearOperator {
public:

  virtual ~LinearOperator() {}

  virtual void update( const Vector<Real> &x, bool flag = true, int iter = -1 ) {}

  virtual void apply( Vector<Real> &Hv, const Vector<Real> &v, Real &tol ) const = 0;

  virtual void applyInverse( Vector<Real> &Hv, const Vector<Real> &v, Real &tol ) const {
    Hv.set(v);
  }

  virtual void applyAdjoint( Vector<Real> &Hv, const Vector<Real> &v, Real &tol ) const {
    apply(Hv,v,tol);
  }

  virtual void applyAdjointInverse( Vector<Real> &Hv, const Vector<Real> &v, Real &tol ) const {
    applyInverse(Hv,v,tol);
  }

}; // class LinearOperator

} // namespace ROL

#endif