gmPackedBuffer.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_PACKED_BUFFER_H_
#define _GEMA_PACKED_BUFFER_H_
 
#include "gmCoreConfig.h"
#include "gmValueSet.h"
#include "gmSingleVector.h"
#include "gmDualVector.h"
 
#include <QVector>
#include <QMap>
 
class GMC_API_EXPORT GmPackedBufferInfo
{
public:
  GmPackedBufferInfo(int id) : _id(id), _padding(0), _stride(0) { _offset.append(0); }
 
  int id() const { return _id; }
 
  void addValueSet(GmValueSet* vs);
  void update(QVector<int>* newSetIndices = NULL);
 
  bool ready() const { return _waitingSets.isEmpty(); }
 
  void removeValueSet(int index);
  bool removePendingValueSet(GmValueSet* vs);
 
  int numSets() const { return _sets.size(); }
 
  int vsIndex(QString id) const { return _map.value(id, -1); }
 
  GmValueSet* vs(int index) const { return _sets[index]; }
 
  int offset(int index) const { return _offset[index]; }
 
  int size(int index) const { return _offset[index + 1] - _offset[index]; }
 
  int stride() const { return _stride; }
 
  void notifyLayoutUpdates();
 
  void clearWaitingList() { _waitingSets.clear(); }
 
#if defined ENABLE_TESTS || defined ENABLE_VALUESET_TESTS
  void validateInternalStructure();
#endif
 
private:
  void updateControlFromPos(int pos);
 
  int sizeofVsStorageType(const GmValueSet* vs) const
  {
    GmValueInfo* info = vs->info();
    return info->canStoreFunctions() ? sizeof(double) : info->sizeofStorageType();
  }
 
  int                  _id;       
  QMap<QString, int>   _map;      
  QVector<GmValueSet*> _sets;     
  QVector<int>         _offset;   
  int                  _padding;  
  int                  _stride;   
 
  QVector<GmValueSet*> _waitingSets; 
};
 
 
class GMC_API_EXPORT GmPackedBuffer
{
public:
  GmPackedBuffer(int id) : _layout(id) {}
 
  virtual ~GmPackedBuffer() {}
 
  const GmPackedBufferInfo* layout() const { return &_layout; }
 
  virtual bool isDual() const = 0;
 
  void addValueSet(GmValueSet* vs);
  bool update();
 
  bool removeValueSet(int index);
  bool removeValueSet(GmValueSet* vs);
 
  int numSets() const { return _layout.numSets(); }
 
  int vsIndex(QString id) const { return _layout.vsIndex(id); }
 
  GmValueSet* vs(int index) const { return _layout.vs(index); }
 
  int vsDataSize(int index) const { return _layout.size(index); }
 
  int vsDataOffset(int index) const { assert(_layout.ready()); return _layout.offset(index); }
 
  int stride() const { assert(_layout.ready()); return _layout.stride(); }
 
  virtual int  numValues() const = 0;
  virtual bool addValues(int numAddedValues) = 0;
  virtual void restoreSize(int oldNumValues) = 0;
  virtual void removeValues(int lineIndex, int numValues) = 0;
 
  virtual void clear() = 0;
 
  virtual size_t usedMemory() const = 0;
  virtual int    numDumpBuffers() const = 0;
  virtual char*  dumpBuffer(int i) const = 0;
  virtual size_t dumpBufferSize(int i) const = 0;
 
#if defined ENABLE_TESTS || defined ENABLE_VALUESET_TESTS
  virtual void validateInternalStructure() = 0;
#endif
 
private:
  Q_DISABLE_COPY(GmPackedBuffer)
 
protected:
  virtual bool updateData(const GmPackedBufferInfo& oldLayout, const QVector<int>* newSetIndices) = 0;
 
  GmPackedBufferInfo _layout;     
};
 
 
template <template <class> class Vector>
class GMC_API_EXPORT GmPackedBufferImpl : public GmPackedBuffer
{
public:
  GmPackedBufferImpl(int id) : GmPackedBuffer(id), _data(new Vector<char>), _numValues(0) {}
 
  virtual ~GmPackedBufferImpl();
 
  virtual bool isDual() const { return _data->isDual(); }
 
  virtual int numValues() const { return _numValues; }
 
  virtual bool addValues   (int numAddedValues);
  virtual void restoreSize (int oldNumValues);
  virtual void removeValues(int lineIndex, int numValues);
 
  char* iptr(int vsIndex, int lineIndex)
  { 
    assert(vsIndex   >= 0 && vsIndex   < numSets()); 
    assert(lineIndex >= 0 && lineIndex < _numValues);
    return _data->iptr((size_t)lineIndex * _layout.stride() + _layout.offset(vsIndex));
  }
 
  const char* iptr(int vsIndex, int lineIndex) const
  {
    assert(vsIndex   >= 0 && vsIndex   < numSets()); 
    assert(lineIndex >= 0 && lineIndex < _numValues);
    return _data->iptr((size_t)lineIndex * _layout.stride() + _layout.offset(vsIndex));
  }
 
  virtual void clear() { _data->clear(); _numValues = 0; }
 
  virtual size_t usedMemory() const { return _data->usedMemory(); }
 
  virtual int numDumpBuffers() const { return _data->numDumpBuffers(); }
 
  virtual char* dumpBuffer(int i) const { return _data->dumpBuffer(i); }
 
  virtual size_t dumpBufferSize(int i) const { return _data->dumpBufferSize(i); }
 
#if defined ENABLE_TESTS || defined ENABLE_VALUESET_TESTS
  virtual void validateInternalStructure();
#endif
 
protected:
  virtual bool updateData(const GmPackedBufferInfo& oldLayout, const QVector<int>* newSetIndices);
 
private:
  Q_DISABLE_COPY(GmPackedBufferImpl)
 
 
  void copyBuffer(const GmPackedBufferInfo* oldInfo, const char* oldBuffer, 
                  const GmPackedBufferInfo* newInfo, char* newBuffer, 
                  size_t numValues, const QVector<const char*>* init = NULL) const;
 
  void fillInitBuffer(QVector<char>& buf, QVector<const char*>& index, const QVector<int>* newSetIndices) const;
 
  Vector<char>* _data;       
  int           _numValues;  
};
 
 
typedef GmPackedBufferImpl<GmSingleVector> GmSinglePackedBuffer;
 
typedef GmPackedBufferImpl<GmDualVectorR> GmDualPackedBuffer;
 
#endif