AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects Version of the Day
AbstractLinAlgPack_VectorSubView.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef ALAP_VECTOR_SUB_VIEW_H
00043 #define ALAP_VECTOR_SUB_VIEW_H
00044 
00045 #include "AbstractLinAlgPack_Vector.hpp"
00046 #include "AbstractLinAlgPack_VectorApplyOpSerialBase.hpp"
00047 #include "AbstractLinAlgPack_VectorSpaceSubSpace.hpp"
00048 
00049 namespace AbstractLinAlgPack {
00050 
00066 class VectorSubView
00067   : virtual public Vector
00068   , virtual protected VectorApplyOpSerialBase
00069 {
00070 public:
00071 
00076   VectorSubView();
00079   VectorSubView( const vec_ptr_t& full_vec, const Range1D& rng );
00097   void initialize( const vec_ptr_t& full_vec, const Range1D& rng );
00105   void set_uninitialized();
00107   const vec_ptr_t& full_vec() const;
00109   const VectorSpaceSubSpace& space_impl() const;
00110 
00113 
00115   const VectorSpace& space() const;
00117   index_type dim() const;
00133   void apply_op(
00134     const RTOpPack::RTOp& op
00135     ,const size_t num_vecs, const Vector* vecs[]
00136     ,const size_t num_targ_vecs, VectorMutable* targ_vecs[]
00137     ,RTOpPack::ReductTarget *reduct_obj
00138     ,const index_type first_ele, const index_type sub_dim, const index_type global_offset
00139     ) const;
00141   value_type get_ele(index_type i) const;
00143   vec_ptr_t sub_view( const Range1D& rng ) const;
00145   void get_sub_vector( const Range1D& rng, RTOpPack::SubVector* sub_vec ) const;
00147   void free_sub_vector( RTOpPack::SubVector* sub_vec ) const;
00148 
00150 
00151 private:
00152 
00153   vec_ptr_t                  full_vec_;   
00154   VectorSpaceSubSpace        space_;      
00155 
00156   // Not defined and not to be called
00157   VectorSubView& operator=(const VectorSubView&);
00158   
00159 }; // end class VectorSubView
00160 
00161 // /////////////////////////////////////////////
00162 // Inline members
00163 
00164 inline
00165 VectorSubView::VectorSubView()
00166 {}
00167 
00168 inline
00169 const VectorSubView::vec_ptr_t&
00170 VectorSubView::full_vec() const
00171 {
00172   return full_vec_;
00173 }
00174 
00175 inline
00176 const VectorSpaceSubSpace& VectorSubView::space_impl() const
00177 {
00178   return space_;
00179 }
00180 
00181 } // end namespace AbstractLinAlgPack
00182 
00183 #endif // ALAP_VECTOR_SUB_VIEW_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends