MOOCHO (Single Doxygen Collection) Version of the Day
AbstractLinAlgPack_MatrixLoadSparseElements.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 // 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 ALAP_MATRIX_LOAD_SPARSE_ELEMENTS_H
00030 #define ALAP_MATRIX_LOAD_SPARSE_ELEMENTS_H
00031 
00032 #include "AbstractLinAlgPack_MatrixBase.hpp"
00033 
00034 namespace AbstractLinAlgPack {
00035 
00058 class MatrixLoadSparseElements
00059   : public virtual AbstractLinAlgPack::MatrixBase
00060 {
00061 public:
00062 
00064   enum EAssumeElementUniqueness {
00065     ELEMENTS_ASSUME_UNIQUE             
00066     ,ELEMENTS_ASSUME_DUPLICATES_SUM    
00067   };
00068 
00075   virtual void reinitialize(
00076     size_type                  rows
00077     ,size_type                 cols
00078     ,size_type                 max_nz
00079     ,EAssumeElementUniqueness  element_uniqueness = ELEMENTS_ASSUME_DUPLICATES_SUM
00080     ) = 0;
00081 
00090   virtual void reset_to_load_values() = 0;
00091 
00119   virtual void get_load_nonzeros_buffers(
00120     size_type      max_nz_load
00121     ,value_type    **val
00122     ,index_type    **row_i
00123     ,index_type    **col_j
00124     ) = 0;
00125 
00153   virtual void commit_load_nonzeros_buffers(
00154     size_type      nz_commit
00155     ,value_type    **val
00156     ,index_type    **row_i
00157     ,index_type    **col_j
00158     ) = 0;
00159 
00175   virtual void finish_construction( bool test_setup ) = 0;
00176 
00177 };  // end class MatrixLoadSparseElements
00178 
00179 } // end namespace AbstractLinAlgPack 
00180 
00181 #endif  // ALAP_MATRIX_LOAD_SPARSE_ELEMENTS_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines