escript  Revision_4925
SparseMatrix.h
Go to the documentation of this file.
1 
2 /*****************************************************************************
3 *
4 * Copyright (c) 2003-2014 by University of Queensland
5 * http://www.uq.edu.au
6 *
7 * Primary Business: Queensland, Australia
8 * Licensed under the Open Software License version 3.0
9 * http://www.opensource.org/licenses/osl-3.0.php
10 *
11 * Development until 2012 by Earth Systems Science Computational Center (ESSCC)
12 * Development 2012-2013 by School of Earth Sciences
13 * Development from 2014 by Centre for Geoscience Computing (GeoComp)
14 *
15 *****************************************************************************/
16 
17 
18 /****************************************************************************/
19 
20 /* Paso: SparseMatrix */
21 
22 /****************************************************************************/
23 
24 /* Author: lgross@uq.edu.au */
25 
26 /****************************************************************************/
27 
28 #ifndef __PASO_SPARSEMATRIX_H__
29 #define __PASO_SPARSEMATRIX_H__
30 
31 #include "Pattern.h"
32 
33 namespace paso {
34 
35 struct SparseMatrix;
36 typedef boost::shared_ptr<SparseMatrix> SparseMatrix_ptr;
37 typedef boost::shared_ptr<const SparseMatrix> const_SparseMatrix_ptr;
38 
39 typedef int SparseMatrixType;
40 
41 // this struct holds a sparse matrix
42 struct SparseMatrix : boost::enable_shared_from_this<SparseMatrix>
43 {
45  dim_t rowBlockSize, dim_t colBlockSize,
46  bool patternIsUnrolled);
47 
48  ~SparseMatrix();
49 
50  void setValues(double value);
51 
52  void copyFromMainDiagonal(double* out) const;
53 
54  void copyToMainDiagonal(const double* in);
55 
56  void copyBlockFromMainDiagonal(double* out) const;
57 
58  void copyBlockToMainDiagonal(const double* in);
59 
60  void applyBlockMatrix(double* block_diag, int* pivot, double* x,
61  const double* b) const;
62 
63  void invMain(double* inv_diag, int* pivot) const;
64 
67  dim_t n_col_sub,
68  const index_t* row_list,
69  const index_t* new_col_index) const;
70 
71  SparseMatrix_ptr getBlock(int blockid) const;
72 
74 
75  void saveHB_CSC(const char* filename) const;
76 
77  void saveMM_CSC(FILE* handle) const;
78 
79  void saveMM(const char* filename) const;
80 
82  {
83  return pattern->borrowMainDiagonalPointer();
84  }
85 
87  {
88  return pattern->borrowColoringPointer();
89  }
90 
91  inline dim_t getNumColors() const
92  {
93  return pattern->getNumColors();
94  }
95 
96  inline dim_t maxDeg() const
97  {
98  return pattern->maxDeg();
99  }
100 
101  inline dim_t getTotalNumRows() const
102  {
103  return numRows * row_block_size;
104  }
105 
106  inline dim_t getTotalNumCols() const
107  {
108  return numCols * col_block_size;
109  }
110 
111  inline dim_t getNumRows() const
112  {
113  return numRows;
114  }
115 
116  inline dim_t getNumCols() const
117  {
118  return numCols;
119  }
120 
121  inline double getSize() const
122  {
123  return (double)len;
124  }
125 
126  inline double getSparsity() const
127  {
128  return getSize() / ((double)getTotalNumRows()*getTotalNumCols());
129  }
130 
131  static SparseMatrix_ptr loadMM_toCSR(const char* filename);
132 
133 
134  void nullifyRowsAndCols_CSC_BLK1(const double* mask_row,
135  const double* mask_col,
136  double main_diagonal_value);
137 
138  void nullifyRowsAndCols_CSR_BLK1(const double* mask_row,
139  const double* mask_col,
140  double main_diagonal_value);
141 
142  void nullifyRowsAndCols_CSC(const double* mask_row, const double* mask_col,
143  double main_diagonal_value);
144 
145  void nullifyRowsAndCols_CSR(const double* mask_row, const double* mask_col,
146  double main_diagonal_value);
147 
148  void nullifyRows_CSR_BLK1(const double* mask_row,
149  double main_diagonal_value);
150 
151  void nullifyRows_CSR(const double* mask_row, double main_diagonal_value);
152 
153  void maxAbsRow_CSR_OFFSET0(double* array) const;
154 
155  void addAbsRow_CSR_OFFSET0(double* array) const;
156 
157  void addRow_CSR_OFFSET0(double* array) const;
158 
159  void applyDiagonal_CSR_OFFSET0(const double* left, const double* right);
160 
169 
171  double *val;
172 
175 
177  void* solver_p;
178 };
179 
180 // interfaces:
181 
182 void SparseMatrix_MatrixVector_CSC_OFFSET0(const double alpha,
184  const double* in,
185  const double beta, double* out);
186 
187 void SparseMatrix_MatrixVector_CSC_OFFSET1(const double alpha,
189  const double* in,
190  const double beta, double* out);
191 
192 void SparseMatrix_MatrixVector_CSR_OFFSET0(const double alpha,
194  const double* in,
195  const double beta, double* out);
196 
197 void SparseMatrix_MatrixVector_CSR_OFFSET1(const double alpha,
199  const double* in,
200  const double beta, double* out);
201 
202 void SparseMatrix_MatrixVector_CSR_OFFSET0_DIAG(const double alpha,
204  const double* in,
205  const double beta, double* out);
206 
209 
213 
214 } // namespace paso
215 
216 #endif // __PASO_SPARSEMATRIX_H__
217 
void copyBlockToMainDiagonal(const double *in)
Definition: SparseMatrix.cpp:401
void SparseMatrix_MatrixVector_CSC_OFFSET0(const double alpha, const_SparseMatrix_ptr A, const double *in, const double beta, double *out)
Definition: SparseMatrix_MatrixVector.cpp:43
boost::shared_ptr< Pattern > Pattern_ptr
Definition: Pattern.h:36
void SparseMatrix_MatrixVector_CSR_OFFSET1(const double alpha, const_SparseMatrix_ptr A, const double *in, const double beta, double *out)
Definition: SparseMatrix_MatrixVector.cpp:189
dim_t block_size
Definition: SparseMatrix.h:164
SparseMatrixType type
Definition: SparseMatrix.h:161
dim_t getNumColors() const
Definition: SparseMatrix.h:91
boost::shared_ptr< const SparseMatrix > const_SparseMatrix_ptr
Definition: SparseMatrix.h:37
dim_t getTotalNumCols() const
Definition: SparseMatrix.h:106
int SparseMatrixType
Definition: SparseMatrix.h:39
void setValues(double value)
Definition: SparseMatrix.cpp:477
void nullifyRows_CSR(const double *mask_row, double main_diagonal_value)
Definition: SparseMatrix_nullifyRowsAndCols.cpp:137
void applyBlockMatrix(double *block_diag, int *pivot, double *x, const double *b) const
Definition: SparseMatrix.cpp:543
dim_t numCols
Definition: SparseMatrix.h:166
void maxAbsRow_CSR_OFFSET0(double *array) const
Definition: SparseMatrix.cpp:366
static SparseMatrix_ptr loadMM_toCSR(const char *filename)
Definition: SparseMatrix.cpp:203
void SparseMatrix_MatrixVector_CSR_OFFSET0(const double alpha, const_SparseMatrix_ptr A, const double *in, const double beta, double *out)
Definition: SparseMatrix_MatrixVector.cpp:275
void copyBlockFromMainDiagonal(double *out) const
Definition: SparseMatrix.cpp:413
void * solver_p
pointer to data needed by a solver
Definition: SparseMatrix.h:177
boost::shared_ptr< SparseMatrix > SparseMatrix_ptr
Definition: SparseMatrix.h:35
dim_t row_block_size
Definition: SparseMatrix.h:162
dim_t getNumCols() const
Definition: SparseMatrix.h:116
dim_t col_block_size
Definition: SparseMatrix.h:163
void nullifyRowsAndCols_CSC(const double *mask_row, const double *mask_col, double main_diagonal_value)
Definition: SparseMatrix_nullifyRowsAndCols.cpp:75
void invMain(double *inv_diag, int *pivot) const
Definition: SparseMatrix.cpp:491
void SparseMatrix_MatrixVector_CSC_OFFSET1(const double alpha, const_SparseMatrix_ptr A, const double *in, const double beta, double *out)
Definition: SparseMatrix_MatrixVector.cpp:118
void addRow_CSR_OFFSET0(double *array) const
Definition: SparseMatrix.cpp:384
dim_t numRows
Definition: SparseMatrix.h:165
index_t * borrowColoringPointer() const
Definition: SparseMatrix.h:86
index_t * borrowMainDiagonalPointer() const
Definition: SparseMatrix.h:81
void nullifyRowsAndCols_CSR_BLK1(const double *mask_row, const double *mask_col, double main_diagonal_value)
Definition: SparseMatrix_nullifyRowsAndCols.cpp:58
void addAbsRow_CSR_OFFSET0(double *array) const
Definition: SparseMatrix.cpp:348
void saveMM_CSC(FILE *handle) const
SparseMatrix_ptr getTranspose() const
Definition: SparseMatrix.cpp:552
void nullifyRows_CSR_BLK1(const double *mask_row, double main_diagonal_value)
Definition: SparseMatrix_nullifyRowsAndCols.cpp:121
dim_t len
Definition: SparseMatrix.h:168
SparseMatrix_ptr getBlock(int blockid) const
Definition: SparseMatrix_getSubmatrix.cpp:85
SparseMatrix_ptr unroll(SparseMatrixType type) const
Definition: SparseMatrix.cpp:628
int index_t
Definition: types.h:25
dim_t maxDeg() const
Definition: SparseMatrix.h:96
void copyFromMainDiagonal(double *out) const
Definition: SparseMatrix.cpp:425
void copyToMainDiagonal(const double *in)
Definition: SparseMatrix.cpp:439
void SparseMatrix_MatrixVector_CSR_OFFSET0_DIAG(const double alpha, const_SparseMatrix_ptr A, const double *in, const double beta, double *out)
Definition: SparseMatrix_MatrixVector.cpp:418
SparseMatrix_ptr getSubmatrix(dim_t n_row_sub, dim_t n_col_sub, const index_t *row_list, const index_t *new_col_index) const
Definition: SparseMatrix_getSubmatrix.cpp:43
Definition: SparseMatrix.h:42
double getSparsity() const
Definition: SparseMatrix.h:126
~SparseMatrix()
Definition: SparseMatrix.cpp:185
SparseMatrix_ptr SparseMatrix_MatrixMatrixTranspose(const_SparseMatrix_ptr A, const_SparseMatrix_ptr B, const_SparseMatrix_ptr T)
Definition: SparseMatrix_MatrixMatrixTranspose.cpp:51
double * val
this is used for classical CSR or CSC
Definition: SparseMatrix.h:171
SparseMatrix_ptr SparseMatrix_MatrixMatrix(const_SparseMatrix_ptr A, const_SparseMatrix_ptr B)
Definition: SparseMatrix_MatrixMatrix.cpp:43
void applyDiagonal_CSR_OFFSET0(const double *left, const double *right)
Definition: SparseMatrix.cpp:453
dim_t getNumRows() const
Definition: SparseMatrix.h:111
index_t solver_package
package controlling the solver pointer
Definition: SparseMatrix.h:174
dim_t getTotalNumRows() const
Definition: SparseMatrix.h:101
void saveHB_CSC(const char *filename) const
Definition: SparseMatrix_saveHB.cpp:174
void nullifyRowsAndCols_CSR(const double *mask_row, const double *mask_col, double main_diagonal_value)
Definition: SparseMatrix_nullifyRowsAndCols.cpp:98
void saveMM(const char *filename) const
Definition: SparseMatrix.cpp:286
SparseMatrix(SparseMatrixType type, Pattern_ptr pattern, dim_t rowBlockSize, dim_t colBlockSize, bool patternIsUnrolled)
Definition: SparseMatrix.cpp:102
double getSize() const
Definition: SparseMatrix.h:121
int dim_t
Definition: types.h:24
Pattern_ptr pattern
Definition: SparseMatrix.h:167
void nullifyRowsAndCols_CSC_BLK1(const double *mask_row, const double *mask_col, double main_diagonal_value)
Definition: SparseMatrix_nullifyRowsAndCols.cpp:41