gmSolverMatrix.h

Go to the documentation of this file.

/************************************************************************
**
** Copyright (C) 2014 by Carlos Augusto Teixera Mendes
** All rights reserved.
**
** This file is part of the "GeMA" software. It's use should respect
** the terms in the license agreement that can be found together
** with this source code.
** It is provided AS IS, with NO WARRANTY OF ANY KIND,
** INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE.
**
************************************************************************/

#ifndef _GEMA_SOLVER_MATRIX_H_
#define _GEMA_SOLVER_MATRIX_H_

#include "gmLog.h"
#include "gmVector.h"
#include "gmDoubleCmp.h"

struct GmSparseMatrixLayout;
class  GmSparseMatrixLayoutBuilder;

class GMC_API_EXPORT GmSolverMatrix 
{
public:

  enum ParallelAddMode
  {
    NO_SUPPORT,          // add() can not be called in parallel from multiple threads
    THREAD_SAFE_SUPPORT, // add() can be freely called from multiple threads. The function implements its own serialization strategy.
    REENTRANT_SUPPORT,   // add() can be called in parallel from multiple threads only if each call adresses a different matrix entry.
  };

  virtual ~GmSolverMatrix() {}

  virtual bool supportsBatchInsert() const = 0;

  virtual bool supportsSparseLayouts() const = 0;

  virtual bool supportsRandomSet() const = 0;

  virtual ParallelAddMode supportedParallelAddMode() const = 0;

  virtual bool beginBatchInsert(size_t expectedEntries = 0) = 0;

  virtual bool endBatchInsert(bool discardData = false) = 0;
  
  virtual GmSparseMatrixLayoutBuilder* layoutBuilder() const = 0;

  virtual bool emptyLayout() const = 0;
  
  virtual bool symmetric() const = 0;

  virtual void setSymmetric(bool sym) = 0;

  virtual int nlin() const = 0;

  virtual int ncol() const = 0;

  virtual int layoutSize() const = 0;

  virtual double at(int lin, int col) const = 0;

  double operator()(int lin, int col) const { return at(lin, col); }

  virtual bool inLayout(int lin, int col) const = 0;

  virtual void set(int lin, int col, double value) = 0;

  virtual void add(int lin, int col, double value) = 0;

  virtual void set(GmSolverMatrix* A, GmSolverMatrix* B, double c, bool sameStructure) = 0;

  virtual void clear(bool keepSparseLayout) = 0;

  virtual void clearLineAndColumnSet(const QList<int>& indexList, bool setDiagonal, bool keepSparseLayout) = 0;

  virtual void ensureDiagonal() = 0;

  virtual void matAdd(const GmVector& a, const GmVector& b, double zeroTol = 0.0) = 0;

  virtual void mul(const GmVector& a, GmVector& b) const = 0;

  virtual void mulAdd(const GmVector& a, GmVector& b) const = 0;

  virtual void mulSub(const GmVector& a, GmVector& b) const = 0;

  virtual void columnMulAdd(int col, GmVector& f, double v, const bool* skipRows = NULL) const = 0;

  virtual size_t usedMemory() const = 0;

  bool isSymmetric(double relTol = GM_DOUBLECMP_RELTOL, double absTol = GM_DOUBLECMP_ABSTOL) const;

  void print(const GmLogCategory& logger, GmLogLevel level, int fieldWidth = 0, char format = 'g', int precision = -1);
};
#endif