AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
AbstractLinAlgPack_MatrixExtractSparseElements.cpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #include <assert.h>
43 
44 #include "AbstractLinAlgPack_MatrixExtractSparseElements.hpp"
45 
46 namespace AbstractLinAlgPack {
47 
48 // Overridden from MatrixConvertToSparseFortranCompatible
49 
50 index_type
52  EExtractRegion extract_region
53  ,EElementUniqueness element_uniqueness
54  ) const
55 {
56  index_type dl,du;
57  get_dl_du(extract_region,&dl,&du);
58  return count_nonzeros(
59  element_uniqueness,NULL,NULL,Range1D(1,rows()),Range1D(1,cols()),dl,du);
60 }
61 
63  EExtractRegion extract_region
64  ,EElementUniqueness element_uniqueness
65  ,const index_type len_Aval
66  ,value_type Aval[]
67  ,const index_type len_Aij
68  ,index_type Arow[]
69  ,index_type Acol[]
70  ,const index_type row_offset
71  ,const index_type col_offset
72  ) const
73 {
74  index_type dl,du;
75  get_dl_du(extract_region, &dl, &du);
77  element_uniqueness
78  ,NULL,NULL,Range1D(1,rows()),Range1D(1,cols()),dl,du
79  ,1.0
80  ,len_Aval,Aval,len_Aij,Arow,Acol,row_offset,col_offset);
81 }
82 
83 // private
84 
85 void MatrixExtractSparseElements::get_dl_du(
86  EExtractRegion extract_region, index_type* dl, index_type* du
87  ) const
88 {
89  const size_type
90  rows = this->rows(),
91  cols = this->cols();
92  switch(extract_region) {
94  *dl = -(rows-1);
95  *du = +(cols-1);
96  break;
98  *dl = 0;
99  *du = +(cols-1);
100  break;
102  *dl = -(rows-1);
103  *du = 0;
104  break;
105  default:
107  break;
108  }
109 }
110 
111 
112 } // end namespace AbstractLinAlgPack
virtual size_type cols() const
Return the number of columns in the matrix.
index_type num_nonzeros(EExtractRegion extract_region, EElementUniqueness element_uniqueness) const
Extract the nonzero elements from the lower triangular region including the diagonal.
virtual index_type count_nonzeros(EElementUniqueness element_uniqueness, const index_type inv_row_perm[], const index_type inv_col_perm[], const Range1D &row_rng, const Range1D &col_rng, index_type dl, index_type du) const =0
Returns the number of nonzeros in the banded submatrix of the permuted matrix.
virtual void coor_extract_nonzeros(EElementUniqueness element_uniqueness, const index_type inv_row_perm[], const index_type inv_col_perm[], const Range1D &row_rng, const Range1D &col_rng, index_type dl, index_type du, value_type alpha, const index_type len_Aval, value_type Aval[], const index_type len_Aij, index_type Arow[], index_type Acol[], const index_type row_offset=0, const index_type col_offset=0) const =0
Extract elements in a coordinate data structure.
virtual size_type rows() const
Return the number of rows in the matrix.
#define TEUCHOS_TEST_FOR_EXCEPT(throw_exception_test)
Extract the nonzero elements from the upper triangular region including the diagonal.