gmVector.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_VECTOR_H_
#define _GEMA_VECTOR_H_

#include "gmCoreConfig.h"

#ifndef GM_VECTOR_DEFINED
#define GM_VECTOR_DEFINED

#include <armadillo>
typedef arma::vec GmVector;  

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

#endif

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

#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_VECTOR(x, ptr, lin) GmVector x((ptr), (lin), false, true)


class GMC_API_EXPORT GmCRVector
{
public:
  GmCRVector(const double* data, int nlin)
    : n_rows(nlin), n_cols(1), n_elem(nlin),
      _vec(const_cast<double*>(data), nlin, false, true) 
  {
  }

  GmCRVector()
    : n_rows(0), n_cols(0), n_elem(0), _vec(NULL, 0, false, true)
  {
  }

  typedef double elem_type;  

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

  operator const GmVector& () { return _vec; }

  const GmVector& v() { return _vec; }

  void setMemory(const double* data, int nlin)
  {
    // 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) = 1; // It might be zero if constructed with the default constructor
    arma::access::rw(n_elem) = nlin;

    GmVectorUtils::setVectorMemory(_vec, const_cast<double*>(data), nlin);
  }

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

  bool is_empty()  const { return _vec.is_empty(); }

  bool in_range(unsigned int ii) const { return _vec.in_range(ii); }

  const double* memptr() const { return _vec.memptr(); }

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

private:
  Q_DISABLE_COPY(GmCRVector)

    GmVector _vec; 
};


#endif