gmVectorUtils.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_UTILS_H_
#define _GEMA_VECTOR_UTILS_H_

#ifndef GM_VECTOR_DEFINED
// Copy of the definition in gmVector.h to break a dependency cycle since gmVector.h must also 
// include gmVectorUtils.h
#define GM_VECTOR_DEFINED
#include <armadillo>
typedef arma::vec GmVector;  
#endif

#include <math.h>
#include "gmLog.h"
#include "gmDoubleCmp.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

class LuaTable;

namespace GmVectorUtils
{

  inline double sqrDistance(const GmVector& a, const GmVector& b)
  {
    assert(a.n_elem == b.n_elem);

    double sum = 0.0;
    for(unsigned int i = 0; i<a.n_elem; i++)
    {
      double d = a[i] - b[i];
      sum += d*d;
    }
    return sum;
  }

  inline double distance(const GmVector& a, const GmVector& b)
  {
    return sqrt(sqrDistance(a, b));
  }

  inline double sqrNorm(const GmVector& v)
  {
    double sum = 0.0;
    for(unsigned int i = 0; i<v.n_elem; i++)
      sum += v[i]*v[i];
    return sum;
  }

  inline double equal(const GmVector& a, const GmVector& b, double relTol = GM_DOUBLECMP_RELTOL, double absTol = GM_DOUBLECMP_ABSTOL)
  {
    if(a.n_elem != b.n_elem)
      return false;
    for(unsigned i = 0; i<a.n_elem; i++)
    {
      if(!GmDoubleCmp::equal(a[i], b[i], relTol, absTol))
        return false;
    }
    return true;
  }

  inline double isZero(const GmVector& a, double absTol)
  {
    for(unsigned i = 0; i<a.n_elem; i++)
    {
      if(!GmDoubleCmp::isZero(a[i], absTol))
        return false;
    }
    return true;
  }


  inline void setVectorMemory(GmVector& v, 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).
    assert(v.vec_state == 1);
    assert(v.mem_state == 2 || (v.mem_state == 0 && v.n_elem == 0 && v.mem == NULL));
    arma::access::rw(v.mem)       = data;
    arma::access::rw(v.mem_state) = 2;
    arma::access::rw(v.n_rows)    = nlin;
    arma::access::rw(v.n_cols)    = 1;
    arma::access::rw(v.n_elem)    = nlin;
  }

  inline void resetVectorMemory(GmVector& v)
  {
    // 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).
    assert(v.vec_state == 1);
    if(v.mem_state == 2)
    {
      arma::access::rw(v.mem) = NULL;
      arma::access::rw(v.mem_state) = 0;
      arma::access::rw(v.n_rows) = 0;
      arma::access::rw(v.n_cols) = 1;
      arma::access::rw(v.n_elem) = 0;
    }
    else if(v.mem_state == 0)
    {
      v.reset();
      arma::access::rw(v.mem) = NULL;
    }
    else
      assert(0);
  }

  inline bool hasSharedMemory(GmVector& v) { return v.mem_state == 2; }

  inline void setVectorSize(GmVector& v, 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).
    assert(v.vec_state == 1);
    assert(v.mem_state == 2);
    assert(v.mem);
    arma::access::rw(v.n_rows) = nlin;
    arma::access::rw(v.n_cols) = 1;
    arma::access::rw(v.n_elem) = nlin;
  }

  GMC_API_EXPORT void print(const GmVector& v, const GmLogCategory& logger, GmLogLevel level, int fieldWidth = 0,
                            char format = 'g', int precision = -1);

  GMC_API_EXPORT QString toString(const GmVector& v, int fieldWidth = 0, char format = 'g', int precision = -1, bool noBraces = false);

  GMC_API_EXPORT void fillFromLuaTable(GmVector& v, LuaTable& t);
  GMC_API_EXPORT bool fillFromLuaTable(GmVector& v, LuaTable& t, int n);
}

#endif