monolish  0.16.0
MONOlithic LInear equation Solvers for Highly-parallel architecture
monolish_coo.hpp
Go to the documentation of this file.
1 #pragma once
2 #include <exception>
3 #include <omp.h>
4 #include <stdexcept>
5 #include <string>
6 #include <vector>
7 
8 #if USE_SXAT
9 #undef _HAS_CPP17
10 #endif
11 #include <random>
12 #if USE_SXAT
13 #define _HAS_CPP17 1
14 #endif
15 
16 #define MM_BANNER "%%MatrixMarket"
17 #define MM_MAT "matrix"
18 #define MM_VEC "vector"
19 #define MM_FMT "coordinate"
20 #define MM_TYPE_REAL "real"
21 #define MM_TYPE_GENERAL "general"
22 #define MM_TYPE_SYMM "symmetric"
23 
24 namespace monolish {
25 template <typename Float> class vector;
26 template <typename TYPE, typename Float> class view1D;
27 namespace matrix {
28 template <typename Float> class Dense;
29 template <typename Float> class CRS;
30 template <typename Float> class LinearOperator;
31 
43 template <typename Float> class COO {
44 private:
48  size_t rowN;
49 
53  size_t colN;
54 
58  size_t nnz;
59 
63  mutable bool gpu_status = false;
64 
65 public:
70  std::vector<int> row_index;
71 
76  std::vector<int> col_index;
77 
82  std::vector<Float> val;
83 
84  COO()
85  : rowN(0), colN(0), nnz(0), gpu_status(false), row_index(), col_index(),
86  val() {}
87 
97  COO(const size_t M, const size_t N)
98  : rowN(M), colN(N), nnz(0), gpu_status(false), row_index(), col_index(),
99  val() {}
100 
116  COO(const size_t M, const size_t N, const size_t NNZ, const int *row,
117  const int *col, const Float *value);
118 
134  COO(const size_t M, const size_t N, const size_t NNZ,
135  const std::vector<int> &row, const std::vector<int> &col,
136  const std::vector<Float> &value) {
137  this = COO(M, N, NNZ, row.data(), col.data(), value.data());
138  }
139 
157  COO(const size_t M, const size_t N, const size_t NNZ,
158  const std::vector<int> &row, const std::vector<int> &col,
159  const vector<Float> &value) {
160  assert(value.get_device_mem_stat() == false);
161  this = COO(M, N, NNZ, row.data(), col.data(), value.data());
162  }
163 
181  COO(const size_t M, const size_t N, const size_t NNZ, const int *row,
182  const int *col, const Float *value, const size_t origin);
183 
201  COO(const size_t M, const size_t N, const size_t NNZ,
202  const std::vector<int> &row, const std::vector<int> &col,
203  const std::vector<Float> &value, const size_t origin) {
204  this = COO(M, N, NNZ, row.data(), col.data(), value.data(), origin);
205  }
206 
215  COO(const matrix::COO<Float> &coo);
216 
226  COO(const matrix::COO<Float> &coo, Float value);
227 
236  void convert(const matrix::CRS<Float> &crs);
237 
246  COO(const matrix::CRS<Float> &crs) { convert(crs); }
247 
256  void convert(const matrix::Dense<Float> &dense);
257 
266  COO(const matrix::Dense<Float> &dense) { convert(dense); }
267 
268  void convert(const matrix::LinearOperator<Float> &linearoperator);
269 
270  COO(const matrix::LinearOperator<Float> &linearoperator) {
271  convert(linearoperator);
272  }
273 
282  void set_row(const size_t M) { rowN = M; };
283 
292  void set_col(const size_t N) { colN = N; };
293 
302  void set_nnz(const size_t NNZ) { nnz = NNZ; };
303 
304  // communication
305  // ///////////////////////////////////////////////////////////////////////////
311  void send() const {
312  throw std::runtime_error("error, GPU util of COO format is not impl. ");
313  };
314 
320  void recv() const {
321  throw std::runtime_error("error, GPU util of COO format is not impl. ");
322  };
323 
329  void device_free() const {};
330 
337  [[nodiscard]] bool get_device_mem_stat() const { return gpu_status; }
338 
344  ~COO() {
345  if (get_device_mem_stat()) {
346  device_free();
347  }
348  }
349 
350  // I/O
351  // ///////////////////////////////////////////////////////////////////////////
352 
361  void input_mm(const std::string filename);
362 
371  COO(const std::string filename) { input_mm(filename); }
372 
381  void output_mm(const std::string filename) const;
382 
391  void print_all(bool force_cpu = false) const;
392 
401  void print_all(const std::string filename) const;
402 
410  [[nodiscard]] Float at(const size_t i, const size_t j) const;
411 
419  [[nodiscard]] Float at(const size_t i, const size_t j) {
420  return static_cast<const COO *>(this)->at(i, j);
421  };
422 
435  void set_ptr(const size_t rN, const size_t cN, const std::vector<int> &r,
436  const std::vector<int> &c, const std::vector<Float> &v);
437 
445  [[nodiscard]] size_t get_row() const { return rowN; }
446 
454  [[nodiscard]] size_t get_col() const { return colN; }
455 
463  [[nodiscard]] size_t get_nnz() const { return nnz; }
464 
473  void fill(Float value);
474 
483  [[nodiscard]] std::vector<int> &get_row_ptr() { return row_index; }
484 
493  [[nodiscard]] std::vector<int> &get_col_ind() { return col_index; }
494 
503  [[nodiscard]] std::vector<Float> &get_val_ptr() { return val; }
504 
513  [[nodiscard]] const std::vector<int> &get_row_ptr() const {
514  return row_index;
515  }
516 
525  [[nodiscard]] const std::vector<int> &get_col_ind() const {
526  return col_index;
527  }
528 
537  [[nodiscard]] const std::vector<Float> &get_val_ptr() const { return val; }
538 
539  // Utility
540  // ///////////////////////////////////////////////////////////////////////////
541 
550  void transpose();
551 
560  void transpose(const COO &B);
561 
569  double get_data_size() const {
570  return 3 * get_nnz() * sizeof(Float) / 1.0e+9;
571  }
572 
580  [[nodiscard]] std::string type() const { return "COO"; }
581 
590  void diag(vector<Float> &vec) const;
591  void diag(view1D<vector<Float>, Float> &vec) const;
592  void diag(view1D<matrix::Dense<Float>, Float> &vec) const;
593 
603  void row(const size_t r, vector<Float> &vec) const;
604  void row(const size_t r, view1D<vector<Float>, Float> &vec) const;
605  void row(const size_t r, view1D<matrix::Dense<Float>, Float> &vec) const;
606 
616  void col(const size_t c, vector<Float> &vec) const;
617  void col(const size_t c, view1D<vector<Float>, Float> &vec) const;
618  void col(const size_t c, view1D<matrix::Dense<Float>, Float> &vec) const;
619 
621 
632  void operator=(const COO<Float> &mat);
633 
644  [[nodiscard]] bool equal(const COO<Float> &mat,
645  bool compare_cpu_and_device = false) const;
646 
656  [[nodiscard]] bool operator==(const COO<Float> &mat) const;
657 
667  [[nodiscard]] bool operator!=(const COO<Float> &mat) const;
668 
684  void insert(const size_t m, const size_t n, const Float val);
685 
686 private:
687  void _q_sort(int lo, int hi);
688 
689 public:
698  void sort(bool merge);
699 };
702 } // namespace matrix
703 } // namespace monolish
monolish::matrix::COO::output_mm
void output_mm(const std::string filename) const
output matrix elements in MatrixMarket format (MatrixMarket format: https://math.nist....
monolish::matrix::COO::row_index
std::vector< int > row_index
Coodinate format row index, which stores row numbers of the non-zero elements (size nnz)
Definition: monolish_coo.hpp:70
monolish::matrix::COO::_q_sort
void _q_sort(int lo, int hi)
monolish::matrix::COO::set_col
void set_col(const size_t N)
Set col number.
Definition: monolish_coo.hpp:292
monolish::matrix::LinearOperator
Linear Operator imitating Matrix.
Definition: monolish_coo.hpp:30
monolish::matrix::COO::operator!=
bool operator!=(const COO< Float > &mat) const
Comparing matrices (A != mat)
monolish::matrix::COO::COO
COO(const size_t M, const size_t N, const size_t NNZ, const std::vector< int > &row, const std::vector< int > &col, const std::vector< Float > &value, const size_t origin)
Create COO matrix from n-origin array.
Definition: monolish_coo.hpp:201
monolish::matrix::COO::device_free
void device_free() const
free data on GPU
Definition: monolish_coo.hpp:329
monolish::matrix::COO::set_row
void set_row(const size_t M)
Set row number.
Definition: monolish_coo.hpp:282
monolish::matrix::COO::operator==
bool operator==(const COO< Float > &mat) const
Comparing matrices (A == mat)
monolish::matrix::COO::at
Float at(const size_t i, const size_t j) const
Get matrix element (A(i,j))
monolish::matrix::COO::get_row
size_t get_row() const
get # of row
Definition: monolish_coo.hpp:445
monolish::matrix::COO::nnz
size_t nnz
# of non-zero element
Definition: monolish_coo.hpp:58
monolish::matrix::COO::COO
COO(const matrix::CRS< Float > &crs)
Create COO matrix from CRS matrix.
Definition: monolish_coo.hpp:246
monolish::matrix::Dense
Dense format Matrix.
Definition: monolish_coo.hpp:28
monolish::matrix::COO::fill
void fill(Float value)
fill matrix elements with a scalar value
monolish::matrix::COO::get_row_ptr
std::vector< int > & get_row_ptr()
get row index
Definition: monolish_coo.hpp:483
monolish::matrix::COO::COO
COO(const matrix::Dense< Float > &dense)
Create COO matrix from Dense matrix (drop zero)
Definition: monolish_coo.hpp:266
monolish::matrix::COO::transpose
void transpose()
get transposed matrix (A^T)
monolish::matrix::COO::insert
void insert(const size_t m, const size_t n, const Float val)
insert element to (m, n)
monolish::vector::data
const Float * data() const
returns a direct pointer to the vector
Definition: monolish_vector.hpp:249
monolish::matrix::COO::val
std::vector< Float > val
Coodinate format value array, which stores values of the non-zero elements (size nnz)
Definition: monolish_coo.hpp:82
monolish::matrix::COO::input_mm
void input_mm(const std::string filename)
Create COO matrix from MatrixMarket format file (only real general) (MatrixMarket format: https://mat...
monolish::matrix::COO::type
std::string type() const
get format name "COO"
Definition: monolish_coo.hpp:580
monolish::matrix::COO::get_val_ptr
std::vector< Float > & get_val_ptr()
get value
Definition: monolish_coo.hpp:503
monolish::matrix::COO::COO
COO(const matrix::LinearOperator< Float > &linearoperator)
Definition: monolish_coo.hpp:270
monolish::matrix::COO::equal
bool equal(const COO< Float > &mat, bool compare_cpu_and_device=false) const
Comparing matrices (A == mat)
monolish::matrix::COO::sort
void sort(bool merge)
sort COO matrix elements (and merge elements)
monolish::matrix::COO::COO
COO(const size_t M, const size_t N)
Initialize M x N COO matrix.
Definition: monolish_coo.hpp:97
monolish::matrix::COO::~COO
~COO()
; free gpu mem.
Definition: monolish_coo.hpp:344
monolish::matrix::COO::diag
void diag(vector< Float > &vec) const
get diag. vector
monolish::matrix::COO::get_row_ptr
const std::vector< int > & get_row_ptr() const
get row index
Definition: monolish_coo.hpp:513
monolish::matrix::COO::get_nnz
size_t get_nnz() const
get # of non-zeros
Definition: monolish_coo.hpp:463
monolish::matrix::COO::row
void row(const size_t r, vector< Float > &vec) const
get row vector
monolish::matrix::COO::print_all
void print_all(bool force_cpu=false) const
print all elements to standard I/O
monolish
monolish namespaces
Definition: monolish_matrix_blas.hpp:5
monolish::matrix::COO::get_col_ind
std::vector< int > & get_col_ind()
get column index
Definition: monolish_coo.hpp:493
monolish::vector::get_device_mem_stat
bool get_device_mem_stat() const
true: sended, false: not send
Definition: monolish_vector.hpp:223
monolish::matrix::COO::get_device_mem_stat
bool get_device_mem_stat() const
false; // true: sended, false: not send
Definition: monolish_coo.hpp:337
monolish::matrix::COO
Coodinate (COO) format Matrix (need to sort)
Definition: monolish_coo.hpp:43
monolish::matrix::COO::send
void send() const
send data to GPU
Definition: monolish_coo.hpp:311
monolish::matrix::COO::set_ptr
void set_ptr(const size_t rN, const size_t cN, const std::vector< int > &r, const std::vector< int > &c, const std::vector< Float > &v)
Set COO array from std::vector.
monolish::view1D
1D view class
Definition: monolish_coo.hpp:26
monolish::matrix::COO::set_nnz
void set_nnz(const size_t NNZ)
Set # of non-zero elements.
Definition: monolish_coo.hpp:302
monolish::matrix::COO::convert
void convert(const matrix::CRS< Float > &crs)
Create COO matrix from CRS matrix.
monolish::matrix::COO::at
Float at(const size_t i, const size_t j)
Get matrix element (A(i,j))
Definition: monolish_coo.hpp:419
monolish::matrix::COO::COO
COO()
Definition: monolish_coo.hpp:84
monolish::matrix::COO::get_data_size
double get_data_size() const
Memory data space required by the matrix.
Definition: monolish_coo.hpp:569
monolish::matrix::COO::COO
COO(const size_t M, const size_t N, const size_t NNZ, const std::vector< int > &row, const std::vector< int > &col, const vector< Float > &value)
Create COO matrix from monolish::vector.
Definition: monolish_coo.hpp:157
monolish::matrix::COO::operator=
void operator=(const COO< Float > &mat)
matrix copy
monolish::vector
vector class
Definition: monolish_coo.hpp:25
monolish::matrix::COO::colN
size_t colN
# of col
Definition: monolish_coo.hpp:53
monolish::matrix::COO::COO
COO(const std::string filename)
Create COO matrix from MatrixMarket format file (only real general) (MatrixMarket format: https://mat...
Definition: monolish_coo.hpp:371
monolish::matrix::COO::COO
COO(const size_t M, const size_t N, const size_t NNZ, const std::vector< int > &row, const std::vector< int > &col, const std::vector< Float > &value)
Create COO matrix from std::vector.
Definition: monolish_coo.hpp:134
monolish::matrix::COO::gpu_status
bool gpu_status
true: sended, false: not send
Definition: monolish_coo.hpp:63
monolish::matrix::COO::recv
void recv() const
recv data from GPU
Definition: monolish_coo.hpp:320
monolish::matrix::COO::rowN
size_t rowN
# of row
Definition: monolish_coo.hpp:48
monolish::matrix::COO::get_col
size_t get_col() const
get # of col
Definition: monolish_coo.hpp:454
monolish::matrix::COO::get_val_ptr
const std::vector< Float > & get_val_ptr() const
get value
Definition: monolish_coo.hpp:537
monolish::matrix::COO::get_col_ind
const std::vector< int > & get_col_ind() const
get column index
Definition: monolish_coo.hpp:525
monolish::matrix::COO::col_index
std::vector< int > col_index
Coodinate format column index, which stores column numbers of the non-zero elements (size nnz)
Definition: monolish_coo.hpp:76
monolish::matrix::CRS
Compressed Row Storage (CRS) format Matrix.
Definition: monolish_coo.hpp:29
monolish::matrix::COO::col
void col(const size_t c, vector< Float > &vec) const
get column vector