gmSparseMatrixOptions.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_OPTIONS_H_
#define _GEMA_SPARSE_MATRIX_OPTIONS_H_

#include "gmCoreConfig.h"

#include "gmSparseMatrixTripletData.h"

class GmSimulationData;
class LuaTable;

enum GmSparseMatrixLayoutMode
{
  GM_TRIPLET_LIST,  
  GM_HASH_LAYOUT,   
  GM_VECTOR_LAYOUT, 
  // ----------------------------------------------------------------------
  GM_ARMADILLO_TRIPLET_LIST,
};

#define GM_MATRIX_OPTIONS_DEF_RESIZE_FACTOR 2.0

class GMC_API_EXPORT GmSparseMatrixOptions
{
public:
  GmSparseMatrixOptions(GmSparseMatrixLayoutMode defMode);

  GmSparseMatrixOptions(const GmSimulationData* simulation, GmSparseMatrixLayoutMode defMode);

  bool loadUserDefinitions(LuaTable& table, QString& err);

  GmSparseMatrixLayoutMode mode() const { return _mode; }

  const char* modeStr() const { return matrixModeToStr(_mode); }

  bool lowMemory() const { return _lowMemory; }

  GmSparseMatrixTripletBufferSortStrategy tripletSortStrategy() const 
  { 
    if(_tripletSortStrategy < 0)
      return _lowMemory ? GM_TRIBUF_SS_ISORT_MERGE : GM_TRIBUF_SS_CONCAT_PCSORT;
    else
      return (GmSparseMatrixTripletBufferSortStrategy)_tripletSortStrategy;
  }

  size_t reserve() const { return _reserve; }

  double resizeFactor() const { return _resizeFactor; }

  int numThreads() const { return _nthreads; }

  void setNumThreads(int nthreads);

  void setMode(GmSparseMatrixLayoutMode mode) { _mode = mode; }

  void setLowMemory(bool mode)  { _lowMemory = mode; }

  void setTripletSortStrategy(GmSparseMatrixTripletBufferSortStrategy st) { _tripletSortStrategy = st; }

private:
  static bool  checkLowMemoryCondition(const GmSimulationData* simulation);
  static const char* matrixModeToStr(GmSparseMatrixLayoutMode mode);
  static int         strToMatrixMode(const QString& str);

  GmSparseMatrixLayoutMode _mode;  
  bool   _lowMemory;    
  size_t _reserve;      
  double _resizeFactor; 
  int    _nthreads;     
  int    _tripletSortStrategy; 
};

#endif