fiff_sparse_matrix.h

Go to the documentation of this file.

//=============================================================================================================
#ifndef FIFFSPARSEMATRIX_H
#define FIFFSPARSEMATRIX_H

//=============================================================================================================
// INCLUDES
//=============================================================================================================

#include "../fiff_global.h"
#include "../fiff_types.h"
#include "../fiff_tag.h"

//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================

#include <Eigen/Core>

//=============================================================================================================
// QT INCLUDES
//=============================================================================================================

#include <QSharedPointer>
#include <QDebug>

//=============================================================================================================
// DEFINE NAMESPACE FIFFLIB
//=============================================================================================================

namespace FIFFLIB
{

//=============================================================================================================
class FIFFSHARED_EXPORT FiffSparseMatrix
{
public:
    typedef QSharedPointer<FiffSparseMatrix> SPtr;              
    typedef QSharedPointer<const FiffSparseMatrix> ConstSPtr;   
    //=========================================================================================================
    FiffSparseMatrix();

    //=========================================================================================================
    FiffSparseMatrix(const FiffSparseMatrix& mat);

    //=========================================================================================================
    ~FiffSparseMatrix();

    //============================= fiff_sparse.c =============================
    /*
     * Interpret dimensions and nz from matrix data
     */
    static FIFFLIB::fiff_int_t *fiff_get_matrix_sparse_dims(FIFFLIB::FiffTag::SPtr& tag);

    /*
     * Conversion into the standard representation
     */
    static FIFFLIB::FiffSparseMatrix* fiff_get_float_sparse_matrix(FIFFLIB::FiffTag::SPtr& tag);

    //============================= mne_sparse_matop.c =============================

    //Refactored: mne_create_sparse_rcs
    static FIFFLIB::FiffSparseMatrix* create_sparse_rcs( int nrow,       /* Number of rows */
                                                            int ncol,       /* Number of columns */
                                                            int *nnz,       /* Number of non-zero elements on each row */
                                                            int **colindex, /* Column indices of non-zero elements on each row */
                                                            float **vals);

    FIFFLIB::FiffSparseMatrix* mne_add_upper_triangle_rcs();

public:
    FIFFLIB::fiff_int_t   coding;    
    FIFFLIB::fiff_int_t   m;         
    FIFFLIB::fiff_int_t   n;         
    FIFFLIB::fiff_int_t   nz;        
    FIFFLIB::fiff_float_t *data;     
    FIFFLIB::fiff_int_t   *inds;     
    FIFFLIB::fiff_int_t   *ptrs;     
// ### OLD STRUCT ###
//typedef struct _fiff_sparse_matrix {
//    fiff_int_t   coding;    /**< coding (storage) type of the sparse matrix. */
//    fiff_int_t   m;         /**< m rows. */
//    fiff_int_t   n;         /**< n columns. */
//    fiff_int_t   nz;        /**< nz nonzeros. */
//    fiff_float_t *data;     /**< owns the data. */
//    fiff_int_t   *inds;     /**< index list, points into data, no dealloc!. */
//    fiff_int_t   *ptrs;     /**< pointer list, points into data, no dealloc!. */
//} *fiffSparseMatrix, fiffSparseMatrixRec;
};

//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
} // NAMESPACE FIFFLIB

#endif // FIFFSPARSEMATRIX_H