RTOp Package Browser (Single Doxygen Collection) Version of the Day
RTOpPack_RTOpSubRangeDecorator_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_RTOP_SUB_RANGE_DECORATOR_DECL_HPP
00044 #define RTOPPACK_RTOP_SUB_RANGE_DECORATOR_DECL_HPP
00045 
00046 
00047 #include "RTOpPack_RTOpT.hpp"
00048 #include "Teuchos_ConstNonconstObjectContainer.hpp"
00049 
00050 
00051 namespace RTOpPack {
00052 
00053 
00084 template<class Scalar>
00085 class RTOpSubRangeDecorator : public RTOpT<Scalar> {
00086 public:
00087 
00090 
00092   typedef typename RTOpT<Scalar>::primitive_value_type primitive_value_type;
00093   
00095 
00098 
00100   RTOpSubRangeDecorator();
00101 
00103   RTOpSubRangeDecorator(
00104     const RCP<RTOpT<Scalar> > &op,
00105     const Ordinal first_ele_offset = 0,
00106     const Ordinal sub_dim = -1
00107     );
00108 
00110   RTOpSubRangeDecorator(
00111     const RCP<const RTOpT<Scalar> > &op,
00112     const Ordinal first_ele_offset = 0,
00113     const Ordinal sub_dim = -1
00114     );
00115 
00117   void nonconstInitialize(
00118     const RCP<RTOpT<Scalar> > &op,
00119     const Ordinal first_ele_offset = 0,
00120     const Ordinal sub_dim = -1
00121     );
00122 
00124   void initialize(
00125     const RCP<const RTOpT<Scalar> > &op,
00126     const Ordinal first_ele_offset = 0,
00127     const Ordinal sub_dim = -1
00128     );
00129 
00131   RCP<RTOpT<Scalar> > getNonconstOp();
00132 
00134   RCP<const RTOpT<Scalar> > getOp() const;
00135 
00137 
00140 
00142   void get_reduct_type_num_entries_impl(
00143     const Ptr<int> &num_values,
00144     const Ptr<int> &num_indexes,
00145     const Ptr<int> &num_chars
00146     ) const;
00148   Teuchos::RCP<ReductTarget> reduct_obj_create_impl() const;
00150   void reduce_reduct_objs_impl( const ReductTarget &in_reduct_obj,
00151     const Ptr<ReductTarget> &inout_reduct_obj) const;
00153   void reduct_obj_reinit_impl( const Ptr<ReductTarget> &reduct_obj ) const;
00155   void extract_reduct_obj_state_impl(
00156     const ReductTarget &reduct_obj,
00157     const ArrayView<primitive_value_type> &value_data,
00158     const ArrayView<index_type> &index_data,
00159     const ArrayView<char_type> &char_data
00160     ) const;
00162   void load_reduct_obj_state_impl(
00163     const ArrayView<const primitive_value_type> &value_data,
00164     const ArrayView<const index_type> &index_data,
00165     const ArrayView<const char_type> &char_data,
00166     const Ptr<ReductTarget> &reduct_obj
00167     ) const;
00169   std::string op_name_impl() const;
00171   bool coord_invariant_impl() const;
00173   void apply_op_impl(
00174     const ArrayView<const ConstSubVectorView<Scalar> > &sub_vecs,
00175     const ArrayView<const SubVectorView<Scalar> > &targ_sub_vecs,
00176     const Ptr<ReductTarget> &reduct_obj
00177     ) const;
00178 
00180 
00181 private:
00182 
00183   Teuchos::ConstNonconstObjectContainer<RTOpT<Scalar> > op_;
00184   Ordinal first_ele_offset_;
00185   Ordinal sub_dim_;
00186 
00187 };
00188 
00189 
00190 } // namespace RTOpPack
00191 
00192 
00193 #endif // RTOPPACK_RTOP_SUB_RANGE_DECORATOR_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines