// @HEADER
// ************************************************************************
//
//               Rapid Optimization Library (ROL) Package
//                 Copyright (2014) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact lead developers:
//              Drew Kouri   (dpkouri@sandia.gov) and
//              Denis Ridzal (dridzal@sandia.gov)
//
// ************************************************************************
// @HEADER

#ifndef ROL_DIAGONALOPERATOR_H
#define ROL_DIAGONALOPERATOR_H

#include "ROL_Vector.hpp"
#include "ROL_Elementwise_Function.hpp"
#include "ROL_LinearOperator.hpp"


/** @ingroup func_group
    \class ROL::DiagonalOperator
    \brief Provides the interface to apply a diagonal operator which acts like
           elementwise multiplication when apply() is used and elementwise division
           when applyInverse() is used.
*/

namespace ROL {

template<class Real>
class DiagonalOperator : public LinearOperator<Real> {

private:
 
  Teuchos::RCP<Vector<Real> >             diag_;

  const Elementwise::Multiply<Real>       mult_;
  const Elementwise::Divide<Real>         div_;   

public:

  DiagonalOperator( const Vector<Real> &diag ) : diag_(diag.clone()) {
    diag_->set(diag);
  }

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

  void apply( Vector<Real> &Hv, const Vector<Real> &v, Real &tol ) const {
    Hv.set(v); 
    Hv.applyBinary( mult_, *diag_ );
  }

  void applyInverse( Vector<Real> &Hv, const Vector<Real> &v, Real &tol ) const {
    Hv.set(v); 
    Hv.applyBinary( div_, *diag_ );
  }

};

} // namespace ROL




#endif // ROL_DIAGONALOPERATOR_H

