AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects Version of the Day
AbstractLinAlgPack_SparseElement.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_ELEMENT_H
00043 #define SPARSE_ELEMENT_H
00044 
00045 #include "AbstractLinAlgPack_Types.hpp"
00046 
00047 namespace AbstractLinAlgPack {
00048 
00059 template <class T_Index, class T_Value>
00060 class SparseElement {
00061 public:
00064 
00066   typedef T_Value           value_type;
00068   typedef T_Index           index_type;
00069 
00071 
00074 
00076   SparseElement()
00077   {
00078     idx_pad_.index_  = 0;
00079     value_           = 0.0;
00080   }
00081 
00083   SparseElement(index_type index, value_type value)
00084   {
00085     idx_pad_.index_ = index;
00086     value_          = value;
00087   }
00088   
00090 
00093 
00095   value_type& value()
00096   {
00097     return value_;
00098   }
00100   const value_type& value() const
00101   {
00102     return value_;
00103   }
00105   const index_type& index() const
00106   {
00107     return idx_pad_.index_;
00108   }
00110   void initialize(index_type index, value_type value) {
00111     idx_pad_.index_ = index;
00112     value_          = value;
00113   } 
00115   void change_index(index_type index)
00116   {
00117     idx_pad_.index_ = index;
00118   }
00119 
00121 
00122 private:
00123   union index_and_padding {
00124     value_type  dummy;     // This is just included for alignment
00125     index_type index_;   // so that sizeof(this) == 2*sizeof(value_type)
00126   };
00127   index_and_padding   idx_pad_;
00128   value_type        value_;
00129 
00130 };  // end class SparseElement
00131 
00132 } // end namespace AbstractLinAlgPack 
00133 
00134 #endif // SPARSE_ELEMENT_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends