RTOp Package Browser (Single Doxygen Collection) Version of the Day
RTOpPack_TOpLinearCombination_decl.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // RTOp: Interfaces and Support Software for Vector Reduction Transformation
00005 //       Operations
00006 //                Copyright (2006) Sandia Corporation
00007 // 
00008 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00009 // license for use of this work by or on behalf of the U.S. Government.
00010 // 
00011 // This library is free software; you can redistribute it and/or modify
00012 // it under the terms of the GNU Lesser General Public License as
00013 // published by the Free Software Foundation; either version 2.1 of the
00014 // License, or (at your option) any later version.
00015 //  
00016 // This library is distributed in the hope that it will be useful, but
00017 // WITHOUT ANY WARRANTY; without even the implied warranty of
00018 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00019 // Lesser General Public License for more details.
00020 //  
00021 // You should have received a copy of the GNU Lesser General Public
00022 // License along with this library; if not, write to the Free Software
00023 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00024 // USA
00025 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00026 // 
00027 // ***********************************************************************
00028 // @HEADER
00029 
00030 #ifndef RTOPPACK_TOP_LINEAR_COMBINATION_DECL_HPP
00031 #define RTOPPACK_TOP_LINEAR_COMBINATION_DECL_HPP
00032 
00033 #include "RTOpPack_RTOpTHelpers.hpp"
00034 #include "Teuchos_Workspace.hpp"
00035 
00036 
00037 namespace RTOpPack {
00038 
00039 
00050 template<class Scalar>
00051 class TOpLinearCombination : public RTOpT<Scalar> {
00052 public:
00053 
00055   TOpLinearCombination(
00056     const ArrayView<const Scalar> &alpha_in = Teuchos::null,
00057     const Scalar &beta = Teuchos::ScalarTraits<Scalar>::zero()
00058     );
00059 
00061   void alpha( const ArrayView<const Scalar> &alpha_in );
00062 
00064   const ArrayView<const Scalar> alpha() const;
00065 
00067   void beta( const Scalar& beta_in );
00068 
00070   Scalar beta() const;
00071 
00073   int num_vecs() const;
00074 
00077 
00079   void apply_op_impl(
00080     const ArrayView<const ConstSubVectorView<Scalar> > &sub_vecs,
00081     const ArrayView<const SubVectorView<Scalar> > &targ_sub_vecs,
00082     const Ptr<ReductTarget> &reduct_obj_inout
00083     ) const;
00084 
00086 
00087 private:
00088 
00089   Scalar beta_;
00090   Array<Scalar> alpha_;
00091 
00092 };
00093 
00094 
00095 } // namespace RTOpPack
00096 
00097 
00098 #endif // RTOPPACK_TOP_LINEAR_COMBINATION_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines