RTOp Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
RTOpPack_TOpLinearCombination_decl.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // RTOp: Interfaces and Support Software for Vector Reduction Transformation
5 // Operations
6 // Copyright (2006) Sandia Corporation
7 //
8 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
9 // license for use of this work by or on behalf of the U.S. Government.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
39 //
40 // ***********************************************************************
41 // @HEADER
42 
43 #ifndef RTOPPACK_TOP_LINEAR_COMBINATION_DECL_HPP
44 #define RTOPPACK_TOP_LINEAR_COMBINATION_DECL_HPP
45 
46 #include "RTOpPack_RTOpTHelpers.hpp"
47 #include "Teuchos_Workspace.hpp"
48 
49 
50 namespace RTOpPack {
51 
52 
63 template<class Scalar>
64 class TOpLinearCombination : public RTOpT<Scalar> {
65 public:
66 
69  const ArrayView<const Scalar> &alpha_in = Teuchos::null,
71  );
72 
74  void alpha( const ArrayView<const Scalar> &alpha_in );
75 
77  const ArrayView<const Scalar> alpha() const;
78 
80  void beta( const Scalar& beta_in );
81 
83  Scalar beta() const;
84 
86  int num_vecs() const;
87 
90 
92  void apply_op_impl(
93  const ArrayView<const ConstSubVectorView<Scalar> > &sub_vecs,
94  const ArrayView<const SubVectorView<Scalar> > &targ_sub_vecs,
95  const Ptr<ReductTarget> &reduct_obj_inout
96  ) const;
97 
99 
100 private:
101 
102  Scalar beta_;
104 
105 };
106 
107 
108 } // namespace RTOpPack
109 
110 
111 #endif // RTOPPACK_TOP_LINEAR_COMBINATION_DECL_HPP
Linear combination transformation operator: z0[i] = beta*z0[i].
Class for a changeable sub-vector.
Class for a non-changeable sub-vector.
Templated interface to vector reduction/transformation operators {abstract}.
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
const ArrayView< const Scalar > alpha() const
TOpLinearCombination(const ArrayView< const Scalar > &alpha_in=Teuchos::null, const Scalar &beta=Teuchos::ScalarTraits< Scalar >::zero())