MOOCHO (Single Doxygen Collection) Version of the Day
AbstractLinAlgPack_VectorDenseEncap.hpp
Go to the documentation of this file.
00001 /*
00002 // @HEADER
00003 // ***********************************************************************
00004 // 
00005 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00006 //                  Copyright (2003) 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 
00044 // /////////////////////////////////////////////////////////////////////
00045 // AbstractLinAlgPack_VectorDenseEncap.hpp
00046 
00047 #ifndef SLAP_VECTOR_DENSE_ENCAP_H
00048 #define SLAP_VECTOR_DENSE_ENCAP_H
00049 
00050 #include "AbstractLinAlgPack_Types.hpp"
00051 #include "AbstractLinAlgPack_VectorMutable.hpp"
00052 #include "DenseLinAlgPack_DVectorClass.hpp"
00053 
00054 namespace AbstractLinAlgPack {
00055 
00078 class VectorDenseEncap {
00079 public:
00080 
00082   VectorDenseEncap( const Vector&  vec );
00084   ~VectorDenseEncap();
00086   const DVectorSlice& operator()() const;
00087 
00088 private:
00089 
00090   const Vector            &vec_;
00091   RTOpPack::SubVector     sub_vec_;
00092   DVectorSlice            vs_;
00093   VectorDenseEncap();                                     // Not defined and not to be called!
00094   VectorDenseEncap(const VectorDenseEncap&);              // ""
00095   VectorDenseEncap& operator=(const VectorDenseEncap&);   // ""
00096 
00097 }; // end class VectorDenseEncap
00098 
00105 class VectorDenseMutableEncap {
00106 public:
00107 
00109   VectorDenseMutableEncap( VectorMutable&  vec );
00111   ~VectorDenseMutableEncap();
00113   DVectorSlice& operator()();
00115   const DVectorSlice& operator()() const;
00116 
00117 private:
00118 
00119   VectorMutable                  &vec_;
00120   RTOpPack::MutableSubVector     sub_vec_;
00121   DVectorSlice                   vs_;
00122   VectorDenseMutableEncap();                                            // Not defined and not to be called!
00123   VectorDenseMutableEncap(const VectorDenseMutableEncap&);              // ""
00124   VectorDenseMutableEncap& operator=(const VectorDenseMutableEncap&);   // ""
00125 
00126 }; // end class VectorDenseMutableEncap
00127 
00128 // ///////////////////////////////////////////
00129 // Inline members
00130 
00131 // VectorDenseEncap
00132 
00133 inline
00134 VectorDenseEncap::VectorDenseEncap( const Vector&  vec )
00135   :vec_(vec)
00136 {
00137   vec_.get_sub_vector(Range1D(),&sub_vec_);
00138   vs_.bind( DVectorSlice(
00139           const_cast<value_type*>(sub_vec_.values())
00140           ,sub_vec_.subDim()
00141           ,sub_vec_.stride()
00142           )
00143     );
00144 }
00145 
00146 inline
00147 VectorDenseEncap::~VectorDenseEncap()
00148 {
00149   vec_.free_sub_vector(&sub_vec_);
00150 }
00151 
00152 inline
00153 const DVectorSlice& VectorDenseEncap::operator()() const
00154 {
00155   return vs_;
00156 }
00157 
00158 // VectorDenseMutableEncap
00159 
00160 inline
00161 VectorDenseMutableEncap::VectorDenseMutableEncap( VectorMutable&  vec )
00162   :vec_(vec)
00163 {
00164   vec_.get_sub_vector(Range1D(),&sub_vec_);
00165   vs_.bind( DVectorSlice(
00166           sub_vec_.values()
00167           ,sub_vec_.subDim()
00168           ,sub_vec_.stride()
00169           )
00170     );
00171 }
00172 
00173 inline
00174 VectorDenseMutableEncap::~VectorDenseMutableEncap()
00175 {
00176   vec_.commit_sub_vector(&sub_vec_);
00177 }
00178 
00179 inline
00180 DVectorSlice& VectorDenseMutableEncap::operator()()
00181 {
00182   return vs_;
00183 }
00184 
00185 inline
00186 const DVectorSlice& VectorDenseMutableEncap::operator()() const
00187 {
00188   return vs_;
00189 }
00190 
00191 } // end namespace SparseLinALgPack
00192 
00193 #endif // SLAP_VECTOR_DENSE_ENCAP_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines