MOOCHO (Single Doxygen Collection) Version of the Day
AbstractLinAlgPack_MatrixExtractSparseElements.cpp
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 // 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 #include <assert.h>
00043 
00044 #include "AbstractLinAlgPack_MatrixExtractSparseElements.hpp"
00045 
00046 namespace AbstractLinAlgPack {
00047 
00048 // Overridden from MatrixConvertToSparseFortranCompatible
00049 
00050 index_type
00051 MatrixExtractSparseElements::num_nonzeros(
00052   EExtractRegion        extract_region
00053   ,EElementUniqueness   element_uniqueness
00054   ) const
00055 {
00056   index_type dl,du;
00057   get_dl_du(extract_region,&dl,&du);
00058   return count_nonzeros(
00059     element_uniqueness,NULL,NULL,Range1D(1,rows()),Range1D(1,cols()),dl,du);
00060 }
00061 
00062 void MatrixExtractSparseElements::coor_extract_nonzeros(
00063   EExtractRegion                extract_region
00064   ,EElementUniqueness           element_uniqueness
00065   ,const index_type             len_Aval
00066   ,value_type                   Aval[]
00067   ,const index_type             len_Aij
00068   ,index_type                   Arow[]
00069   ,index_type                   Acol[]
00070   ,const index_type             row_offset
00071   ,const index_type             col_offset
00072    ) const
00073 {
00074   index_type dl,du;
00075   get_dl_du(extract_region, &dl, &du);
00076   coor_extract_nonzeros(
00077     element_uniqueness
00078     ,NULL,NULL,Range1D(1,rows()),Range1D(1,cols()),dl,du
00079     ,1.0
00080     ,len_Aval,Aval,len_Aij,Arow,Acol,row_offset,col_offset);
00081 }
00082 
00083 // private
00084 
00085 void MatrixExtractSparseElements::get_dl_du(
00086   EExtractRegion extract_region, index_type* dl, index_type* du
00087   ) const
00088 {
00089   const size_type
00090     rows = this->rows(),
00091     cols = this->cols();
00092   switch(extract_region) {
00093     case EXTRACT_FULL_MATRIX:
00094       *dl = -(rows-1);
00095       *du = +(cols-1);
00096       break;
00097     case EXTRACT_UPPER_TRIANGULAR:
00098       *dl = 0;
00099       *du = +(cols-1);
00100       break;
00101     case EXTRACT_LOWER_TRIANGULAR:
00102       *dl = -(rows-1);
00103       *du = 0;
00104       break;
00105     default:
00106       TEUCHOS_TEST_FOR_EXCEPT(true);
00107       break;
00108   }
00109 }
00110 
00111 
00112 } // end namespace AbstractLinAlgPack 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines