AbstractLinAlgPack_MatrixExtractSparseElements.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_EXTRACT_SPARSE_ELEMENTS_H
00030 #define ALAP_MATRIX_EXTRACT_SPARSE_ELEMENTS_H
00031 
00032 #include "AbstractLinAlgPack_MatrixConvertToSparse.hpp"
00033 
00034 namespace AbstractLinAlgPack {
00035 
00088 class MatrixExtractSparseElements
00089   : public virtual MatrixConvertToSparse
00090 {
00091 public:
00092 
00221   virtual index_type count_nonzeros(
00222     EElementUniqueness    element_uniqueness
00223     ,const index_type     inv_row_perm[]
00224     ,const index_type     inv_col_perm[]
00225     ,const Range1D        &row_rng
00226     ,const Range1D        &col_rng
00227     ,index_type           dl
00228     ,index_type           du
00229     ) const = 0;
00230 
00343   virtual void coor_extract_nonzeros(
00344     EElementUniqueness    element_uniqueness
00345     ,const index_type     inv_row_perm[]
00346     ,const index_type     inv_col_perm[]
00347     ,const Range1D        &row_rng
00348     ,const Range1D        &col_rng
00349     ,index_type           dl
00350     ,index_type           du
00351     ,value_type           alpha
00352     ,const index_type     len_Aval
00353     ,value_type           Aval[]
00354     ,const index_type     len_Aij
00355     ,index_type           Arow[]
00356     ,index_type           Acol[]
00357     ,const index_type     row_offset = 0
00358     ,const index_type     col_offset = 0
00359     ) const = 0;
00360 
00361   // ToDo: Add methods for extracting compressed row (column) elements!
00362 
00365 
00367   index_type num_nonzeros(
00368     EExtractRegion        extract_region
00369     ,EElementUniqueness   element_uniqueness
00370     ) const;
00372   void coor_extract_nonzeros(
00373     EExtractRegion                extract_region
00374     ,EElementUniqueness           element_uniqueness
00375     ,const index_type             len_Aval
00376     ,value_type                   Aval[]
00377     ,const index_type             len_Aij
00378     ,index_type                   Arow[]
00379     ,index_type                   Acol[]
00380     ,const index_type             row_offset
00381     ,const index_type             col_offset
00382     ) const;
00383 
00385 
00386 private:
00387 
00389   void get_dl_du( EExtractRegion extract_region, index_type* dl, index_type* du ) const;
00390 
00391 };  // end class MatrixExtractSparseElements
00392 
00393 } // end namespace AbstractLinAlgPack 
00394 
00395 #endif  // ALAP_MATRIX_EXTRACT_SPARSE_ELEMENTS_H

Generated on Thu Sep 18 12:35:11 2008 for MOOCHO (Single Doxygen Collection) by doxygen 1.3.9.1