AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects Version of the Day
AbstractLinAlgPack_SparsePtrElement.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 SPARSE_PTR_ELEMENT_H
00043 #define SPARSE_PTR_ELEMENT_H
00044 
00045 #include "AbstractLinAlgPack_Types.hpp"
00046 
00047 namespace AbstractLinAlgPack {
00048 
00058 template <class T_Indice, class T_Value>
00059 class SparsePtrElement {
00060 public:
00063 
00065   typedef T_Value             value_type;
00067   typedef T_Indice            indice_type;
00068 
00070 
00073 
00075   SparsePtrElement() : indice_(0), pvalue_(0)
00076   {}
00077 
00079   SparsePtrElement(indice_type indice, value_type* pvalue) : indice_(indice), pvalue_(pvalue)
00080   {}
00081   
00083 
00086 
00088   value_type& value()
00089   {
00090     return *pvalue_;
00091   }
00093   value_type value() const
00094   {
00095     return *pvalue_;
00096   }
00098   indice_type indice() const
00099   {
00100     return indice_;
00101   }
00103   void change_indice(indice_type indice)
00104   {
00105     indice_ = indice;
00106   }
00108   void change_value_ptr(value_type* pvalue)
00109   {
00110     pvalue_ = pvalue;
00111   }
00112 
00114 private:
00115   indice_type       indice_;
00116   value_type*       pvalue_;
00117 
00118 };  // end class SparsePtrElement
00119 
00120 } // end namespace AbstractLinAlgPack 
00121 
00122 #endif // SPARSE_PTR_ELEMENT_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends