RTOp Package Browser (Single Doxygen Collection) Version of the Day
RTOpPack_ROpGetSubVector_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 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00039 // 
00040 // ***********************************************************************
00041 // @HEADER
00042 
00043 #ifndef RTOPPACK_ROP_GET_SUB_VECTOR_DECL_HPP
00044 #define RTOPPACK_ROP_GET_SUB_VECTOR_DECL_HPP
00045 
00046 
00047 #include "RTOpPack_RTOpTHelpers.hpp"
00048 
00049 
00050 namespace RTOpPack {
00051 
00052 
00058 template<class Scalar>
00059 class ROpGetSubVector : public RTOpT<Scalar> {
00060 public:
00061 
00063   typedef typename RTOpT<Scalar>::primitive_value_type primitive_value_type;
00064 
00066   ROpGetSubVector( const index_type l = 0, const index_type u = 0 );
00067 
00069   void set_range( const index_type l, const index_type u );
00070 
00074   const ConstSubVectorView<Scalar> operator()(
00075     const ReductTarget& reduct_obj ) const;
00076 
00079 
00081   void get_reduct_type_num_entries_impl(
00082     const Ptr<int> &num_values,
00083     const Ptr<int> &num_indexes,
00084     const Ptr<int> &num_chars
00085     ) const;
00087   Teuchos::RCP<ReductTarget> reduct_obj_create_impl() const;
00089   void reduce_reduct_objs_impl( const ReductTarget &in_reduct_obj,
00090     const Ptr<ReductTarget> &inout_reduct_obj) const;
00092   void reduct_obj_reinit_impl( const Ptr<ReductTarget> &reduct_obj ) const;
00094   void extract_reduct_obj_state_impl(
00095     const ReductTarget &reduct_obj,
00096     const ArrayView<primitive_value_type> &value_data,
00097     const ArrayView<index_type> &index_data,
00098     const ArrayView<char_type> &char_data
00099     ) const;
00101   void load_reduct_obj_state_impl(
00102     const ArrayView<const primitive_value_type> &value_data,
00103     const ArrayView<const index_type> &index_data,
00104     const ArrayView<const char_type> &char_data,
00105     const Ptr<ReductTarget> &reduct_obj
00106     ) const;
00108   bool coord_invariant_impl() const;
00110   void apply_op_impl(
00111     const ArrayView<const ConstSubVectorView<Scalar> > &sub_vecs,
00112     const ArrayView<const SubVectorView<Scalar> > &targ_sub_vecs,
00113     const Ptr<ReductTarget> &reduct_obj
00114     ) const;
00115 
00117 
00118 private:
00119 
00120   index_type l_;
00121   index_type u_;
00122 
00123 }; // class ROpGetSubVector
00124 
00125 
00126 } // namespace RTOpPack
00127 
00128 
00129 #endif // RTOPPACK_ROP_GET_SUB_VECTOR_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines