gmSparseMatrixTripletData.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_TRIPLET_DATA_H_
#define _GEMA_SPARSE_MATRIX_TRIPLET_DATA_H_

#include "gmCoreConfig.h"
#include "gmSparseMatrixLayout.h"
#include "gmAppendBuffer.h"

// The current implementation expects that the key vector inside
// the triplet data in GmSparseMatrixTripletData conforms to:
//  - Size equal to 64 bits
//  - Unsigned values (although stored into an int - ugly)
//  - Little endianess so that when interpreting the key as an unsigned 64 bit
//    value, the value at position 0 is the LEAST significant value
//
//  This characteristics are used both by the internal operator < (which is much
//  faster than a standard way with multiple compares) and by integer sorting 
//  routines in gmIntegerSort.h

#if Q_BYTE_ORDER != Q_LITTLE_ENDIAN
#error Invalid Triplet layout 
#endif

static_assert(2 * sizeof(int) == sizeof(quint64), "Unexpected int size in triplet layout");


template <GmSparseMatrixLayoutTypes T> 
struct GMC_API_EXPORT GmSparseMatrixTripletData
{
  int    _key[2]; 
  double _value;  

  GmSparseMatrixTripletData(int lin, int col, double val);

  GmSparseMatrixTripletData(int ptr, int index, double val, bool) : _key{ index, ptr }, _value(val) {}

  GmSparseMatrixTripletData() : _key{ -1, -1 }, _value(0.0) {} 

  int ptr() const { return _key[1]; }

  int index() const { return _key[0]; }

  bool operator<(const GmSparseMatrixTripletData<T>& other) const
  {
    // Same as:
    // return (_key[1] < other._key[1]) || (_key[1] == other._key[1] && _key[0] < other._key[0]);
    return *((quint64*)(&_key[0])) < *((quint64*)(&other._key[0]));
  }
};

// Constructor implementation for CSR layout
template <> inline
GmSparseMatrixTripletData<GM_CSR_SPARSE_FORMAT>::GmSparseMatrixTripletData(int lin, int col, double val)
  : _key{ col, lin }, _value(val) {}

// Constructor implementation for CSC layout
template <> inline
GmSparseMatrixTripletData<GM_CSC_SPARSE_FORMAT>::GmSparseMatrixTripletData(int lin, int col, double val)
  : _key{ lin, col }, _value(val) {}


// Optimize use with QVarLengthArray like a POD type (no default constructor called, copyable with memcpy, etc).
Q_DECLARE_TYPEINFO(GmSparseMatrixTripletData<GM_CSC_SPARSE_FORMAT>, Q_PRIMITIVE_TYPE);
Q_DECLARE_TYPEINFO(GmSparseMatrixTripletData<GM_CSR_SPARSE_FORMAT>, Q_PRIMITIVE_TYPE);


enum GmSparseMatrixTripletBufferSortStrategy
{
  GM_TRIBUF_SS_CONCAT_PCSORT, 
  GM_TRIBUF_SS_ISORT_MERGE,   
};


template <GmSparseMatrixLayoutTypes T>
class GmSparseMatrixTripletBuffer : public GmAppendBuffer<GmSparseMatrixTripletData<T> >
{
public:
  virtual GmSparseMatrixTripletData<T>* sortedData(int nlin, GmSparseMatrixTripletBufferSortStrategy st) = 0;

  static int         strToSortStrategy(const QString& str);
  static const char* sortStrategyToStr(GmSparseMatrixTripletBufferSortStrategy st);
};

template <GmSparseMatrixLayoutTypes T>
class GmSparseMatrixSingleTripletBuffer : public GmSingleAppendBuffer<GmSparseMatrixTripletData<T>, GmSparseMatrixTripletBuffer<T> >
{
public:
  GmSparseMatrixSingleTripletBuffer(size_t initSize, double resizeFactor = 2.0, int numThreads = -1)
    : GmSingleAppendBuffer(initSize, resizeFactor, numThreads) {}

  virtual GmSparseMatrixTripletData<T>* sortedData(int nlin, GmSparseMatrixTripletBufferSortStrategy st);
};

template <GmSparseMatrixLayoutTypes T>
class GmSparseMatrixPerThreadTripletBuffer : public GmPerThreadAppendBuffer<GmSparseMatrixTripletData<T>, GmSparseMatrixTripletBuffer<T> >
{
public:
  GmSparseMatrixPerThreadTripletBuffer(size_t initSize, double resizeFactor = 2.0, int numThreads = -1)
    : GmPerThreadAppendBuffer(initSize, resizeFactor, numThreads) {}

  virtual GmSparseMatrixTripletData<T>* sortedData(int nlin, GmSparseMatrixTripletBufferSortStrategy st);
};

#endif