RTOpPack_TOpLinearCombination_decl.hpp

// @HEADER
// ***********************************************************************
// 
// RTOp: Interfaces and Support Software for Vector Reduction Transformation
//       Operations
//                Copyright (2006) 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.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef RTOPPACK_TOP_LINEAR_COMBINATION_DECL_HPP
#define RTOPPACK_TOP_LINEAR_COMBINATION_DECL_HPP

#include "RTOpPack_RTOpTHelpers.hpp"
#include "Teuchos_Workspace.hpp"


namespace RTOpPack {


template<class Scalar>
class TOpLinearCombination : public RTOpT<Scalar> {
public:

  TOpLinearCombination(
    const ArrayView<const Scalar> &alpha_in = Teuchos::null,
    const Scalar &beta = Teuchos::ScalarTraits<Scalar>::zero()
    );

  void alpha( const ArrayView<const Scalar> &alpha_in );

  const ArrayView<const Scalar> alpha() const;

  void beta( const Scalar& beta_in );

  Scalar beta() const;

  int num_vecs() const;


  void apply_op_impl(
    const ArrayView<const ConstSubVectorView<Scalar> > &sub_vecs,
    const ArrayView<const SubVectorView<Scalar> > &targ_sub_vecs,
    const Ptr<ReductTarget> &reduct_obj_inout
    ) const;


private:

  Scalar beta_;
  Array<Scalar> alpha_;

};


} // namespace RTOpPack


#endif // RTOPPACK_TOP_LINEAR_COMBINATION_DECL_HPP