MOOCHO (Single Doxygen Collection) Version of the Day
AbstractLinAlgPack_SparseCOOPtrElement.hpp
Go to the documentation of this file.
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_COO_PTR_ELEMENT_H
00043 #define SPARSE_COO_PTR_ELEMENT_H
00044 
00045 #include "AbstractLinAlgPack_Types.hpp"
00046 
00047 namespace AbstractLinAlgPack {
00048 
00058 template <class T_Index, class T_Value>
00059 class SparseCOOPtrElement {
00060 public:
00063 
00065   typedef T_Value           value_type;
00067   typedef T_Index           index_type;
00068 
00070 
00073 
00075   SparseCOOPtrElement() : pvalue_(0), row_i_(0), col_j_(0)
00076   {}
00077 
00079   SparseCOOPtrElement(value_type* pvalue, index_type row_i, index_type col_j)
00080     : pvalue_(pvalue), row_i_(row_i), col_j_(col_j)
00081   {}
00082 
00084   void initialize(value_type* pvalue, index_type row_i, index_type col_j) {
00085     pvalue_ = pvalue;
00086     row_i_  = row_i;
00087     col_j_  = col_j;
00088   }
00089   
00091 
00094 
00096   value_type& value()
00097   {
00098     return *pvalue_;
00099   }
00101   value_type value() const
00102   {
00103     return *pvalue_;
00104   }
00106   index_type row_i() const
00107   {
00108     return row_i_;
00109   }
00111   index_type col_j() const
00112   {
00113     return col_j_;
00114   }
00116   void change_indexes(index_type row_i, index_type col_j)
00117   {
00118     row_i_ = row_i;
00119     col_j_ = col_j;
00120   }
00122   void change_value_ptr(value_type* pvalue)
00123   {
00124     pvalue_ = pvalue;
00125   }
00126 
00128 private:
00129   value_type*       pvalue_;
00130   index_type        row_i_, col_j_;
00131 
00132 };  // end class SparseCOOPtrElement
00133 
00134 } // end namespace AbstractLinAlgPack 
00135 
00136 #endif // SPARSE_COO_PTR_ELEMENT_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines