gmSparseMatrixLayout.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_SPARSE_MATRIX_LAYOUT_H_
#define _GEMA_SPARSE_MATRIX_LAYOUT_H_
 
#include "gmCoreConfig.h"
 
#include <armadillo>
#include <QObject>
 
#if 0
#define ENABLE_MATRIX_LAYOUT_INDEX_CACHE 1
#endif
 
#ifdef ENABLE_MATRIX_LAYOUT_INDEX_CACHE
#include "gmThreadLocalStorage.h"
#endif
 
 
class GmLogCategory;
 
enum GmSparseMatrixLayoutTypes
{
  GM_CSC_SPARSE_FORMAT,  
  GM_CSR_SPARSE_FORMAT,  
};
 
 
struct GMC_API_EXPORT GmSparseMatrixLayout : public QObject
{
  Q_OBJECT
 
public:
  GmSparseMatrixLayout(GmSparseMatrixLayoutTypes type) : _type(type), _shared(false) {}
 
  virtual ~GmSparseMatrixLayout() {}
 
  virtual bool empty() const = 0;
 
  virtual void clear() = 0;
 
  virtual int index(int row, int col) const = 0;
 
  virtual int dindex(int n) const = 0;
 
  virtual void printStatistics(const GmLogCategory& logger) const = 0;
 
  void emitLayoutCompleted() { emit layoutCompleted(); }
 
  GmSparseMatrixLayoutTypes _type;   
  mutable bool              _shared; 
 
#ifdef ENABLE_TESTS
  virtual void checkLayoutData() const = 0;
#endif
 
signals:
  void layoutCompleted();
 
private:
  Q_DISABLE_COPY(GmSparseMatrixLayout)
};
 
 
template <class IndexType, GmSparseMatrixLayoutTypes T> 
struct GMC_API_EXPORT GmCSxSparseMatrixLayout: public GmSparseMatrixLayout
{
public:
  GmCSxSparseMatrixLayout(bool arma) : GmSparseMatrixLayout(T)
  {
    _ptr  = _index = NULL;
    _n    = _nnz   = 0;
    _arma = arma;
 
#ifdef ENABLE_MATRIX_LAYOUT_INDEX_CACHE
    _lastIndex.init(-1);
#endif
  }
 
  virtual ~GmCSxSparseMatrixLayout()
  {
    delete[] _ptr;
    delete[] _index;
  }
 
  // See comments on the base class
  virtual bool empty() const { return _n == 0; }
 
  // See comments on the base class
  virtual void clear()
  {
    delete[] _ptr;
    delete[] _index;
    _ptr = _index = NULL;
    _n   = _nnz   = 0;
 
#ifdef ENABLE_MATRIX_LAYOUT_INDEX_CACHE
    _lastIndex.init(-1);
#endif
  }
 
  // Index implementation is specialized explicitly in the cpp file to avoid the need of an 'if' checking 
  // the layout type.  Although this is static and the compiler should be able to optimize the if, looking
  // at the generated optimized code does not clarify if the compiler is really doing that :(.
  virtual int index(int row, int col) const;
 
  // See comments on the base class.  TODO: Should we try to optimize searching first in the center values?
  virtual int dindex(int n) const { return indexWorker(_ptr[n], _ptr[n+1], n); }
 
  virtual void printStatistics(const GmLogCategory& logger) const;
 
#ifdef ENABLE_TESTS
  virtual void checkLayoutData() const;
#endif
 
  IndexType* _ptr;   
  IndexType* _index; 
  int        _n;     
  int        _nnz;   
  int        _arma;  
 
#ifdef ENABLE_MATRIX_LAYOUT_INDEX_CACHE
  mutable GmTLS<int, true> _lastIndex;  
#endif
 
protected:
    inline int indexWorker(int start, int end, int ind) const;
};
 
 
/*  If ever changing arma type to a 32-bits value, please make sure to review the code in
  GmVectorCSxSparseMatrixLayoutBuilder. This will open the possibility of reusing the
  builder internal vector as the layout index vector. Care will also be needed in that case
  with allocating space for the arma sentinel value in the builder vector.
*/
 
 
typedef GmCSxSparseMatrixLayout<int, GM_CSR_SPARSE_FORMAT> GmCSRSparseMatrixLayout;
 
typedef GmCSxSparseMatrixLayout<arma::uword, GM_CSR_SPARSE_FORMAT> GmCSRArmadilloSparseMatrixLayout;
 
typedef GmCSxSparseMatrixLayout<int, GM_CSC_SPARSE_FORMAT> GmCSCSparseMatrixLayout;
 
typedef GmCSxSparseMatrixLayout<arma::uword, GM_CSC_SPARSE_FORMAT> GmCSCArmadilloSparseMatrixLayout;
 
#endif