gmMatrix.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_MATRIX_H_
#define _GEMA_MATRIX_H_

#include "gmCoreConfig.h"

#ifndef GM_MATRIX_DEFINED
#define GM_MATRIX_DEFINED

#include <armadillo>
typedef arma::mat GmMatrix;  

// Register type for storing them inside a QVariant
#include <QMetaType>
Q_DECLARE_METATYPE(GmMatrix);

#endif

// A define that can be used by code that expects that the matrix is stored in 
// column major format to check and mark that.
// Unfortuantely, this define was created late in the game, so do not assume
// that every (rare) place in GeMA that depends on a GmMatrix being column major 
// (as an optimization) to have an assert :(
#define GM_MATRIX_IS_COLUMN_MAJOR

#include "gmMatrixUtils.h"
#include <assert.h>


typedef arma::subview_col<double> GmMatrixCol;

#if ARMA_VERSION_MAJOR != 5 || ARMA_VERSION_MINOR != 200
#error Unexpected Armadillo version.  Please check that our internal fiddling done bellow is still valid
#endif

#define DECLARE_REF_MATRIX(x, ptr, lin, col) GmMatrix x((ptr), (lin), (col), false, true)


class GMC_API_EXPORT GmCRMatrix
{
public:
  GmCRMatrix(const double* data, int nlin, int ncol)
    : n_rows(nlin), n_cols(ncol), n_elem(nlin*ncol),
      _mat(const_cast<double*>(data), nlin, ncol, false, true) 
  {
  }

  GmCRMatrix()
    : n_rows(0), n_cols(0), n_elem(0), _mat(NULL, 0, 0, false, true) 
  {
  }

  typedef double elem_type;  

  const unsigned int  n_rows;    
  const unsigned int  n_cols;    
  const unsigned int  n_elem;    

  operator const GmMatrix& () { return _mat; }

  const GmMatrix& m() { return _mat; }
  
  void setMemory(const double* data, int nlin, int ncol)
  {
    // Ugly hack ahead.  Please close your eyes.  This is dependent on the Armadillo
    // implementation and is done only because there is really no other way (short of
    // changing the library itself).  Not very different from this whole class, by the way.
    arma::access::rw(n_rows) = nlin;
    arma::access::rw(n_cols) = ncol;
    arma::access::rw(n_elem) = nlin * ncol;

    GmMatrixUtils::setMatrixMemory(_mat, const_cast<double*>(data), nlin, ncol);
  }

  const double& operator[] (unsigned int ii) const  { return _mat[ii]; }
  const double& at(unsigned int ii) const           { return _mat.at(ii); }
  const double& operator() (unsigned int ii) const  { return _mat(ii); }

  const double& at(unsigned int in_row, unsigned int in_col) const          { return _mat.at(in_row, in_col); }
  const double& operator() (unsigned int in_row, unsigned int in_col) const { return _mat(in_row, in_col); }

  bool is_empty()  const { return _mat.is_empty(); }
  bool is_vec()    const { return _mat.is_vec(); }
  bool is_rowvec() const { return _mat.is_rowvec(); }
  bool is_colvec() const { return _mat.is_colvec(); }
  bool is_square() const { return _mat.is_square(); }

  bool in_range(unsigned int ii) const                          { return _mat.in_range(ii); }
  bool in_range(unsigned int in_row, unsigned int in_col) const { return _mat.in_range(in_row, in_col); }

  const double* colptr(unsigned int in_col) const { return _mat.colptr(in_col); }
  const double* memptr() const                    { return _mat.memptr(); }

  bool         empty() const { return _mat.empty(); }
  unsigned int size()  const { return _mat.size(); }

private:
  Q_DISABLE_COPY(GmCRMatrix)

  GmMatrix _mat; 
};

#endif