AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects Version of the Day
AbstractLinAlgPack_MatrixLoadSparseElements.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 ALAP_MATRIX_LOAD_SPARSE_ELEMENTS_H
00043 #define ALAP_MATRIX_LOAD_SPARSE_ELEMENTS_H
00044 
00045 #include "AbstractLinAlgPack_MatrixBase.hpp"
00046 
00047 namespace AbstractLinAlgPack {
00048 
00071 class MatrixLoadSparseElements
00072   : public virtual AbstractLinAlgPack::MatrixBase
00073 {
00074 public:
00075 
00077   enum EAssumeElementUniqueness {
00078     ELEMENTS_ASSUME_UNIQUE             
00079     ,ELEMENTS_ASSUME_DUPLICATES_SUM    
00080   };
00081 
00088   virtual void reinitialize(
00089     size_type                  rows
00090     ,size_type                 cols
00091     ,size_type                 max_nz
00092     ,EAssumeElementUniqueness  element_uniqueness = ELEMENTS_ASSUME_DUPLICATES_SUM
00093     ) = 0;
00094 
00103   virtual void reset_to_load_values() = 0;
00104 
00132   virtual void get_load_nonzeros_buffers(
00133     size_type      max_nz_load
00134     ,value_type    **val
00135     ,index_type    **row_i
00136     ,index_type    **col_j
00137     ) = 0;
00138 
00166   virtual void commit_load_nonzeros_buffers(
00167     size_type      nz_commit
00168     ,value_type    **val
00169     ,index_type    **row_i
00170     ,index_type    **col_j
00171     ) = 0;
00172 
00188   virtual void finish_construction( bool test_setup ) = 0;
00189 
00190 };  // end class MatrixLoadSparseElements
00191 
00192 } // end namespace AbstractLinAlgPack 
00193 
00194 #endif  // ALAP_MATRIX_LOAD_SPARSE_ELEMENTS_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends