base_matrix.hpp

Go to the documentation of this file.

#ifndef PARALUTION_BASE_MATRIX_HPP_
#define PARALUTION_BASE_MATRIX_HPP_

#include "base_vector.hpp"
#include "matrix_formats.hpp"
#include <vector>

namespace paralution {

// Forward declartions
template <typename ValueType>
class HostMatrix;
template <typename ValueType>
class HostMatrixCSR;
template <typename ValueType>
class HostMatrixCOO;
template <typename ValueType>
class HostMatrixDIA;
template <typename ValueType>
class HostMatrixELL;
template <typename ValueType>
class HostMatrixHYB;
template <typename ValueType>
class HostMatrixDENSE;
template <typename ValueType>
class HostMatrixMCSR;
template <typename ValueType>
class HostMatrixBCSR;

template <typename ValueType>
class AcceleratorMatrix;

template <typename ValueType>
class GPUAcceleratorMatrix;
template <typename ValueType>
class GPUAcceleratorMatrixCSR;
template <typename ValueType>
class GPUAcceleratorMatrixMCSR;
template <typename ValueType>
class GPUAcceleratorMatrixBCSR;
template <typename ValueType>
class GPUAcceleratorMatrixCOO;
template <typename ValueType>
class GPUAcceleratorMatrixDIA;
template <typename ValueType>
class GPUAcceleratorMatrixELL;
template <typename ValueType>
class GPUAcceleratorMatrixHYB;
template <typename ValueType>
class GPUAcceleratorMatrixDENSE;

template <typename ValueType>
class OCLAcceleratorMatrix;
template <typename ValueType>
class OCLAcceleratorMatrixCSR;
template <typename ValueType>
class OCLAcceleratorMatrixMCSR;
template <typename ValueType>
class OCLAcceleratorMatrixBCSR;
template <typename ValueType>
class OCLAcceleratorMatrixCOO;
template <typename ValueType>
class OCLAcceleratorMatrixDIA;
template <typename ValueType>
class OCLAcceleratorMatrixELL;
template <typename ValueType>
class OCLAcceleratorMatrixHYB;
template <typename ValueType>
class OCLAcceleratorMatrixDENSE;

template <typename ValueType>
class MICAcceleratorMatrix;
template <typename ValueType>
class MICAcceleratorMatrixCSR;
template <typename ValueType>
class MICAcceleratorMatrixMCSR;
template <typename ValueType>
class MICAcceleratorMatrixBCSR;
template <typename ValueType>
class MICAcceleratorMatrixCOO;
template <typename ValueType>
class MICAcceleratorMatrixDIA;
template <typename ValueType>
class MICAcceleratorMatrixELL;
template <typename ValueType>
class MICAcceleratorMatrixHYB;
template <typename ValueType>
class MICAcceleratorMatrixDENSE;

template <typename ValueType>
class BaseMatrix {

public:

  BaseMatrix();
  virtual ~BaseMatrix();

  int get_nrow(void) const;
  int get_ncol(void) const;
  int get_nnz(void) const;
  virtual void info(void) const = 0;
  virtual unsigned int get_mat_format(void) const = 0;
  virtual void set_backend(const Paralution_Backend_Descriptor local_backend);

  virtual bool Check(void) const;

  virtual void AllocateCSR(const int nnz, const int nrow, const int ncol);
  virtual void AllocateMCSR(const int nnz, const int nrow, const int ncol);
  virtual void AllocateCOO(const int nnz, const int nrow, const int ncol);
  virtual void AllocateDIA(const int nnz, const int nrow, const int ncol, const int ndiag);
  virtual void AllocateELL(const int nnz, const int nrow, const int ncol, const int max_row);
  virtual void AllocateHYB(const int ell_nnz, const int coo_nnz, const int ell_max_row, 
                           const int nrow, const int ncol);
  virtual void AllocateDENSE(const int nrow, const int ncol);

  virtual void SetDataPtrCOO(int **row, int **col, ValueType **val,
                             const int nnz, const int nrow, const int ncol);
  virtual void LeaveDataPtrCOO(int **row, int **col, ValueType **val);

  virtual void SetDataPtrCSR(int **row_offset, int **col, ValueType **val,
                             const int nnz, const int nrow, const int ncol);
  virtual void LeaveDataPtrCSR(int **row_offset, int **col, ValueType **val);

  virtual void SetDataPtrELL(int **col, ValueType **val,
                             const int nnz, const int nrow, const int ncol, const int max_row);
  virtual void LeaveDataPtrELL(int **col, ValueType **val, int &max_row);

  virtual void SetDataPtrDIA(int **offset, ValueType **val,
                             const int nnz, const int nrow, const int ncol, const int num_diag);
  virtual void LeaveDataPtrDIA(int **offset, ValueType **val, int &num_diag);

  virtual void SetDataPtrDENSE(ValueType **val, const int nrow, const int ncol);
  virtual void LeaveDataPtrDENSE(ValueType **val);

  virtual void Clear(void) = 0;

  virtual bool Zeros(void);

  virtual bool Assemble(const int *i, const int *j, const ValueType *v,
                        const int size, const int n, const int m,
                        int **pp_assembly_rank,
                        int **pp_assembly_irank,
                        int **pp_assembly_loop_start,
                        int **pp_assembly_loop_end,
                        int &nThreads);
  virtual bool AssembleUpdate(const ValueType *v,
                              const int *assembly_rank,
                              const int *assembly_irank,
                              const int *assembly_loop_start,
                              const int *assembly_loop_end,
                              const int nThreads);

  virtual bool Scale(const ValueType alpha);
  virtual bool ScaleDiagonal(const ValueType alpha);
  virtual bool ScaleOffDiagonal(const ValueType alpha);
  virtual bool AddScalar(const ValueType alpha);
  virtual bool AddScalarDiagonal(const ValueType alpha);
  virtual bool AddScalarOffDiagonal(const ValueType alpha);

  virtual bool ExtractSubMatrix(const int row_offset,
                                const int col_offset,
                                const int row_size,
                                const int col_size,
                                BaseMatrix<ValueType> *mat) const;

  virtual bool ExtractDiagonal(BaseVector<ValueType> *vec_diag) const;
  virtual bool ExtractInverseDiagonal(BaseVector<ValueType> *vec_inv_diag) const;
  virtual bool ExtractU(BaseMatrix<ValueType> *U) const;
  virtual bool ExtractUDiagonal(BaseMatrix<ValueType> *U) const;
  virtual bool ExtractL(BaseMatrix<ValueType> *L) const;
  virtual bool ExtractLDiagonal(BaseMatrix<ValueType> *L) const;

  virtual bool Permute(const BaseVector<int> &permutation);

  virtual bool PermuteBackward(const BaseVector<int> &permutation);

  virtual bool CMK(BaseVector<int> *permutation) const;
  virtual bool RCMK(BaseVector<int> *permutation) const;

  virtual bool MultiColoring(int &num_colors, int **size_colors, BaseVector<int> *permutation) const;

  virtual bool MaximalIndependentSet(int &size, BaseVector<int> *permutation) const;

  virtual bool ZeroBlockPermutation(int &size, BaseVector<int> *permutation) const;

  virtual bool ConvertFrom(const BaseMatrix<ValueType> &mat) = 0;

  virtual void CopyFrom(const BaseMatrix<ValueType> &mat) = 0;

  virtual void CopyTo(BaseMatrix<ValueType> *mat) const = 0;

  virtual void CopyFromAsync(const BaseMatrix<ValueType> &mat);

  virtual void CopyToAsync(BaseMatrix<ValueType> *mat) const;

  virtual void CopyFromCSR(const int *row_offsets, const int *col, const ValueType *val);

  virtual void CopyToCSR(int *row_offsets, int *col, ValueType *val) const;

  virtual void CopyFromCOO(const int *row, const int *col, const ValueType *val);

  virtual void CopyToCOO(int *row, int *col, ValueType *val) const;

  virtual bool CreateFromMap(const BaseVector<int> &map, const int n, const int m);

  virtual bool ReadFileMTX(const std::string filename);
  virtual bool WriteFileMTX(const std::string filename) const;

  virtual bool ReadFileCSR(const std::string filename);
  virtual bool WriteFileCSR(const std::string filename) const;

  virtual bool SymbolicPower(const int p);

  virtual bool SymbolicMatMatMult(const BaseMatrix<ValueType> &src);
  virtual bool MatMatMult(const BaseMatrix<ValueType> &A, const BaseMatrix<ValueType> &B);
  virtual bool SymbolicMatMatMult(const BaseMatrix<ValueType> &A, const BaseMatrix<ValueType> &B);
  virtual bool NumericMatMatMult(const BaseMatrix<ValueType> &A, const BaseMatrix<ValueType> &B);
  virtual bool DiagonalMatrixMultR(const BaseVector<ValueType> &diag);
  virtual bool DiagonalMatrixMultL(const BaseVector<ValueType> &diag);
  virtual bool MatrixAdd(const BaseMatrix<ValueType> &mat, const ValueType alpha,
                         const ValueType beta, const bool structure);

  virtual bool ILU0Factorize(void);
  virtual bool LUFactorize(void);
  virtual bool ILUTFactorize(const double t, const int maxrow);
  virtual bool ILUpFactorizeNumeric(const int p, const BaseMatrix<ValueType> &mat);

  virtual bool ICFactorize(BaseVector<ValueType> *inv_diag);

  virtual void LUAnalyse(void);
  virtual void LUAnalyseClear(void);
  virtual bool LUSolve(const BaseVector<ValueType> &in, BaseVector<ValueType> *out) const;

  virtual void LLAnalyse(void);
  virtual void LLAnalyseClear(void);
  // traversing is performed in parallel
  virtual bool LLSolve(const BaseVector<ValueType> &in, BaseVector<ValueType> *out) const;
  virtual bool LLSolve(const BaseVector<ValueType> &in, const BaseVector<ValueType> &inv_diag,
                       BaseVector<ValueType> *out) const;

  virtual void LAnalyse(const bool diag_unit=false);
  virtual void LAnalyseClear(void);
  virtual bool LSolve(const BaseVector<ValueType> &in, BaseVector<ValueType> *out) const;

  virtual void UAnalyse(const bool diag_unit=false);
  virtual void UAnalyseClear(void);
  virtual bool USolve(const BaseVector<ValueType> &in, BaseVector<ValueType> *out) const;

  virtual bool Householder(const int idx, ValueType &beta, BaseVector<ValueType> *vec) const;
  virtual bool QRDecompose(void);
  virtual bool QRSolve(const BaseVector<ValueType> &in, BaseVector<ValueType> *out) const;

  virtual bool Invert(void);

  virtual bool Gershgorin(ValueType &lambda_min, ValueType &lambda_max) const;

  virtual void Apply(const BaseVector<ValueType> &in, BaseVector<ValueType> *out) const = 0;
  virtual void ApplyAdd(const BaseVector<ValueType> &in, const ValueType scalar,
                        BaseVector<ValueType> *out) const = 0;

  virtual bool Compress(const double drop_off);

  virtual bool Transpose(void);

  virtual bool Sort(void);

  virtual bool ReplaceColumnVector(const int idx, const BaseVector<ValueType> &vec);

  virtual bool ReplaceRowVector(const int idx, const BaseVector<ValueType> &vec);

  virtual bool ExtractColumnVector(const int idx, BaseVector<ValueType> *vec) const;

  virtual bool ExtractRowVector(const int idx, BaseVector<ValueType> *vec) const;

  virtual bool AMGConnect(const ValueType eps, BaseVector<int> *connections) const;
  virtual bool AMGAggregate(const BaseVector<int> &connections, BaseVector<int> *aggregates) const;
  virtual bool AMGSmoothedAggregation(const ValueType relax,
                                      const BaseVector<int> &aggregates,
                                      const BaseVector<int> &connections,
                                            BaseMatrix<ValueType> *prolong,
                                            BaseMatrix<ValueType> *restrict) const;
  virtual bool AMGAggregation(const BaseVector<int> &aggregates,
                                    BaseMatrix<ValueType> *prolong,
                                    BaseMatrix<ValueType> *restrict) const;

  virtual bool FSAI(const int power, const BaseMatrix<ValueType> *pattern);

  virtual bool SPAI(void);

protected:

  int nrow_;
  int ncol_;
  int nnz_;

  Paralution_Backend_Descriptor local_backend_;

  friend class BaseVector<ValueType>;
  friend class HostVector<ValueType>;
  friend class AcceleratorVector<ValueType>;
  friend class GPUAcceleratorVector<ValueType>;
  friend class OCLAcceleratorVector<ValueType>;
  friend class MICAcceleratorVector<ValueType>;

};

template <typename ValueType>
class HostMatrix : public BaseMatrix<ValueType> {

public:

  HostMatrix();
  virtual ~HostMatrix();

};

template <typename ValueType>
class AcceleratorMatrix : public BaseMatrix<ValueType> {

public:

  AcceleratorMatrix();
  virtual ~AcceleratorMatrix();

  virtual void CopyFromHost(const HostMatrix<ValueType> &src) = 0;

  virtual void CopyFromHostAsync(const HostMatrix<ValueType> &src);

  virtual void CopyToHost(HostMatrix<ValueType> *dst) const = 0;

  virtual void CopyToHostAsync(HostMatrix<ValueType> *dst) const;

};

template <typename ValueType>
class GPUAcceleratorMatrix : public AcceleratorMatrix<ValueType> {

public:

  GPUAcceleratorMatrix();
  virtual ~GPUAcceleratorMatrix();

};

template <typename ValueType>
class OCLAcceleratorMatrix : public AcceleratorMatrix<ValueType> {

public:

  OCLAcceleratorMatrix();
  virtual ~OCLAcceleratorMatrix();

};

template <typename ValueType>
class MICAcceleratorMatrix : public AcceleratorMatrix<ValueType> {

public:

  MICAcceleratorMatrix();
  virtual ~MICAcceleratorMatrix();

};


}

#endif // PARALUTION_BASE_MATRIX_HPP_