suiteSparseMatrix.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_SUITESPARSE_MATRIX_H_
#define _GEMA_SUITESPARSE_MATRIX_H_
 
#include <gmSparseMatrix.h>
 
#include <cholmod.h> // For cholmod_sparse 
 
template<class IndexType>
class SuiteSparseMatrix : public GmSparseMatrix<IndexType, GM_CSC_SPARSE_FORMAT>
{
public:
 
  SuiteSparseMatrix(int nlin, int ncol, const SuiteSparseMatrix<IndexType>* sharedLayout, GmSparseMatrixOptions options);
  virtual ~SuiteSparseMatrix();
 
  cholmod_sparse* cholmodMatrix() { return &_cholMatrix; }
 
  static cholmod_sparse* newCholmodMatrix(int nlin, int ncol, IndexType nnz, double* values, IndexType* ptrs, IndexType* indices);
 
  virtual void clear(bool keepSparseLayout);
  virtual void clearLineAndColumnSet(const QVector<int>& indexList, bool setDiagonal, bool keepSparseLayout);
  virtual void ensureDiagonal();
 
protected:
  virtual void matrixLayoutReady();
  virtual GmSparseMatrix<IndexType, GM_CSC_SPARSE_FORMAT>* detachAndClear();
 
private:
  void updateCholMatrix();
  void clearCholMatrix();
 
  static void initCholMatrix(cholmod_sparse* m, int nlin, int ncol);
  static void initCholMatrixData(cholmod_sparse* m, IndexType nnz, double* values, IndexType* ptrs, IndexType* indices);
 
  cholmod_sparse _cholMatrix;   
};
 
void SuiteSparseFillCholmodVector(cholmod_dense* v, int nlin, double* values);
 
 
#endif