MOOCHO (Single Doxygen Collection) Version of the Day
AbstractLinAlgPack_MatrixConvertToSparse.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 MATRIX_CONVERT_TO_SPARSE_H
00030 #define MATRIX_CONVERT_TO_SPARSE_H
00031 
00032 #include "AbstractLinAlgPack_Types.hpp"
00033 #include "AbstractLinAlgPack_MatrixBase.hpp"
00034 
00035 namespace AbstractLinAlgPack {
00036 
00075 class MatrixConvertToSparse
00076   : virtual public AbstractLinAlgPack::MatrixBase // doxygen needs full path
00077 {
00078 public:
00079 
00081   enum EExtractRegion {
00082     EXTRACT_FULL_MATRIX       
00083     ,EXTRACT_UPPER_TRIANGULAR 
00084     ,EXTRACT_LOWER_TRIANGULAR 
00085   };
00087   enum EElementUniqueness {
00088     ELEMENTS_FORCE_UNIQUE             
00089     ,ELEMENTS_ALLOW_DUPLICATES_SUM    
00090   };
00091 
00113   virtual index_type num_nonzeros(
00114     EExtractRegion        extract_region
00115     ,EElementUniqueness   element_uniqueness
00116     ) const = 0;
00117 
00305   virtual void coor_extract_nonzeros(
00306     EExtractRegion                extract_region
00307     ,EElementUniqueness           element_uniqueness
00308     ,const index_type             len_Aval
00309     ,value_type                   Aval[]
00310     ,const index_type             len_Aij
00311     ,index_type                   Arow[]
00312     ,index_type                   Acol[]
00313     ,const index_type             row_offset = 0
00314     ,const index_type             col_offset = 0
00315     ) const = 0;
00316   
00317   // Todo: Include extraction routines for Compressed Row (Column) when needed.
00318 
00319 };  // end class MatrixConvertToSparse
00320 
00321 } // end namespace AbstractLinAlgPack 
00322 
00323 #endif  // MATRIX_CONVERT_TO_SPARSE_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines