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 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef SPARSE_ELEMENT_H
00030 #define SPARSE_ELEMENT_H
00031 
00032 #include "AbstractLinAlgPack_Types.hpp"
00033 
00034 namespace AbstractLinAlgPack {
00035 
00046 template <class T_Index, class T_Value>
00047 class SparseElement {
00048 public:
00051 
00053   typedef T_Value           value_type;
00055   typedef T_Index           index_type;
00056 
00058 
00061 
00063   SparseElement()
00064   {
00065     idx_pad_.index_  = 0;
00066     value_           = 0.0;
00067   }
00068 
00070   SparseElement(index_type index, value_type value)
00071   {
00072     idx_pad_.index_ = index;
00073     value_          = value;
00074   }
00075   
00077 
00080 
00082   value_type& value()
00083   {
00084     return value_;
00085   }
00087   const value_type& value() const
00088   {
00089     return value_;
00090   }
00092   const index_type& index() const
00093   {
00094     return idx_pad_.index_;
00095   }
00097   void initialize(index_type index, value_type value) {
00098     idx_pad_.index_ = index;
00099     value_          = value;
00100   } 
00102   void change_index(index_type index)
00103   {
00104     idx_pad_.index_ = index;
00105   }
00106 
00108 
00109 private:
00110   union index_and_padding {
00111     value_type  dummy;     // This is just included for alignment
00112     index_type index_;   // so that sizeof(this) == 2*sizeof(value_type)
00113   };
00114   index_and_padding   idx_pad_;
00115   value_type        value_;
00116 
00117 };  // end class SparseElement
00118 
00119 } // end namespace AbstractLinAlgPack 
00120 
00121 #endif // SPARSE_ELEMENT_H

Generated on Wed May 12 21:50:44 2010 for AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects by  doxygen 1.4.7