AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects Version of the Day
AbstractLinAlgPack_MatrixExtractSparseElements.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_EXTRACT_SPARSE_ELEMENTS_H
00043 #define ALAP_MATRIX_EXTRACT_SPARSE_ELEMENTS_H
00044 
00045 #include "AbstractLinAlgPack_MatrixConvertToSparse.hpp"
00046 
00047 namespace AbstractLinAlgPack {
00048 
00101 class MatrixExtractSparseElements
00102   : public virtual MatrixConvertToSparse
00103 {
00104 public:
00105 
00234   virtual index_type count_nonzeros(
00235     EElementUniqueness    element_uniqueness
00236     ,const index_type     inv_row_perm[]
00237     ,const index_type     inv_col_perm[]
00238     ,const Range1D        &row_rng
00239     ,const Range1D        &col_rng
00240     ,index_type           dl
00241     ,index_type           du
00242     ) const = 0;
00243 
00356   virtual void coor_extract_nonzeros(
00357     EElementUniqueness    element_uniqueness
00358     ,const index_type     inv_row_perm[]
00359     ,const index_type     inv_col_perm[]
00360     ,const Range1D        &row_rng
00361     ,const Range1D        &col_rng
00362     ,index_type           dl
00363     ,index_type           du
00364     ,value_type           alpha
00365     ,const index_type     len_Aval
00366     ,value_type           Aval[]
00367     ,const index_type     len_Aij
00368     ,index_type           Arow[]
00369     ,index_type           Acol[]
00370     ,const index_type     row_offset = 0
00371     ,const index_type     col_offset = 0
00372     ) const = 0;
00373 
00374   // ToDo: Add methods for extracting compressed row (column) elements!
00375 
00378 
00380   index_type num_nonzeros(
00381     EExtractRegion        extract_region
00382     ,EElementUniqueness   element_uniqueness
00383     ) const;
00385   void coor_extract_nonzeros(
00386     EExtractRegion                extract_region
00387     ,EElementUniqueness           element_uniqueness
00388     ,const index_type             len_Aval
00389     ,value_type                   Aval[]
00390     ,const index_type             len_Aij
00391     ,index_type                   Arow[]
00392     ,index_type                   Acol[]
00393     ,const index_type             row_offset
00394     ,const index_type             col_offset
00395     ) const;
00396 
00398 
00399 private:
00400 
00402   void get_dl_du( EExtractRegion extract_region, index_type* dl, index_type* du ) const;
00403 
00404 };  // end class MatrixExtractSparseElements
00405 
00406 } // end namespace AbstractLinAlgPack 
00407 
00408 #endif  // ALAP_MATRIX_EXTRACT_SPARSE_ELEMENTS_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends