fiff_named_matrix.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef FIFF_NAMED_MATRIX_H
#define FIFF_NAMED_MATRIX_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "fiff_global.h"
#include "fiff_constants.h"
#include "fiff_types.h"
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QStringList>
#include <QSharedData>
#include <QSharedDataPointer>
#include <QSharedPointer>
#include <memory>
 
//=============================================================================================================
// DEFINE NAMESPACE FIFFLIB
//=============================================================================================================
 
namespace FIFFLIB
{
 
//=============================================================================================================
class FIFFSHARED_EXPORT FiffNamedMatrix : public QSharedData
{
public:
    using SPtr = QSharedPointer<FiffNamedMatrix>;             
    using ConstSPtr = QSharedPointer<const FiffNamedMatrix>;  
    using UPtr = std::unique_ptr<FiffNamedMatrix>;            
    using ConstUPtr = std::unique_ptr<const FiffNamedMatrix>; 
    using SDPtr = QSharedDataPointer<FiffNamedMatrix>;        
 
    //=========================================================================================================
    FiffNamedMatrix();
 
    //=========================================================================================================
    explicit FiffNamedMatrix(fiff_int_t p_nrow,
                             fiff_int_t p_ncol,
                             const QStringList& p_row_names,
                             const QStringList& p_col_names,
                             const Eigen::MatrixXd& p_data);
 
    //=========================================================================================================
    FiffNamedMatrix(const FiffNamedMatrix& p_FiffNamedMatrix);
 
    //=========================================================================================================
    ~FiffNamedMatrix() = default;
 
    //=========================================================================================================
    void clear();
 
    //=========================================================================================================
    inline bool isEmpty() const;
 
    //ToDo return the transposed matrix instead of applying it to its members
    //=========================================================================================================
    void transpose_named_matrix();
 
    //    //=========================================================================================================
    //    /**
    //    * Assignment Operator
    //    *
    //    * @return rhs   named matrix which hould be assigned.
    //    */
    //    inline FiffNamedMatrix& operator=(const FiffNamedMatrix& rhs);
 
    //=========================================================================================================
    friend std::ostream& operator<<(std::ostream& out, const FIFFLIB::FiffNamedMatrix& p_FiffNamedMatrix);

    friend bool operator==(const FiffNamedMatrix& a, const FiffNamedMatrix& b);
 
public:
    fiff_int_t nrow;       
    fiff_int_t ncol;       
    QStringList row_names; 
    QStringList col_names; 
    Eigen::MatrixXd data;  
};
 
//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
 
//inline FiffNamedMatrix& FiffNamedMatrix::operator=(const FiffNamedMatrix& rhs)
//{
//    // Check for self-assignment!
//    if (this == &rhs)
//        return *this;
//    //Else
//    nrow = rhs.nrow;
//    ncol = rhs.ncol;
//    row_names = rhs.row_names;
//    col_names = rhs.col_names;
//    data = rhs.data;
 
//    return *this;
//}
 
inline bool FiffNamedMatrix::isEmpty() const
{
    return !(this->data.size() > 0);
}
 
//=============================================================================================================
 
inline std::ostream& operator<<(std::ostream& out, const FIFFLIB::FiffNamedMatrix& p_FiffNamedMatrix)
{
    bool t_bIsShort = true;
    out << "#### Fiff Named Matrix ####\n";
    out << "\tnrow: " << p_FiffNamedMatrix.nrow << std::endl;
    out << "\tncol: " << p_FiffNamedMatrix.ncol << std::endl;
 
    Eigen::MatrixXd data; 
 
    out << "\trow_names " << p_FiffNamedMatrix.row_names.size() << ":\n\t";
    if (t_bIsShort) {
        qint32 nchan = p_FiffNamedMatrix.row_names.size() > 6 ? 6 : p_FiffNamedMatrix.row_names.size();
        for (qint32 i = 0; i < nchan / 2; ++i)
            out << p_FiffNamedMatrix.row_names[i].toUtf8().constData() << " ";
        out << "... ";
        for (qint32 i = p_FiffNamedMatrix.row_names.size() - nchan / 2; i < p_FiffNamedMatrix.row_names.size(); ++i)
            out << p_FiffNamedMatrix.row_names[i].toUtf8().constData() << " ";
        out << std::endl;
    }
 
    out << "\tcol_names " << p_FiffNamedMatrix.col_names.size() << ":\n\t";
    if (t_bIsShort) {
        qint32 nchan = p_FiffNamedMatrix.col_names.size() > 6 ? 6 : p_FiffNamedMatrix.col_names.size();
        for (qint32 i = 0; i < nchan / 2; ++i)
            out << p_FiffNamedMatrix.col_names[i].toUtf8().constData() << " ";
        out << "... ";
        for (qint32 i = p_FiffNamedMatrix.col_names.size() - nchan / 2; i < p_FiffNamedMatrix.col_names.size(); ++i)
            out << p_FiffNamedMatrix.col_names[i].toUtf8().constData() << " ";
        out << std::endl;
    }
 
    out << "\tdata " << p_FiffNamedMatrix.data.rows() << " x " << p_FiffNamedMatrix.data.cols() << ":\n\t";
    if (t_bIsShort) {
        qint32 nrows = p_FiffNamedMatrix.data.rows() > 6 ? 6 : p_FiffNamedMatrix.data.rows();
        qint32 ncols = p_FiffNamedMatrix.data.cols() > 6 ? 6 : p_FiffNamedMatrix.data.cols();
        if (nrows == 1) {
            for (qint32 i = 0; i < nrows; ++i) {
                for (qint32 j = 0; j < ncols / 2; ++j)
                    out << p_FiffNamedMatrix.data(i, j) << " ";
                out << "... ";
                for (qint32 j = p_FiffNamedMatrix.data.cols() - ncols / 2; j < p_FiffNamedMatrix.data.cols(); ++j)
                    out << p_FiffNamedMatrix.data(i, j) << " ";
                out << "\n\t";
            }
        } else {
            for (qint32 i = 0; i < nrows / 2; ++i) {
                for (qint32 j = 0; j < ncols / 2; ++j)
                    out << p_FiffNamedMatrix.data(i, j) << " ";
                out << "... ";
                for (qint32 j = p_FiffNamedMatrix.data.cols() - ncols / 2; j < p_FiffNamedMatrix.data.cols(); ++j)
                    out << p_FiffNamedMatrix.data(i, j) << " ";
                out << "\n\t";
            }
            out << "...\n\t";
            for (qint32 i = p_FiffNamedMatrix.data.rows() - nrows / 2; i < p_FiffNamedMatrix.data.rows(); ++i) {
                for (qint32 j = 0; j < ncols / 2; ++j)
                    out << p_FiffNamedMatrix.data(i, j) << " ";
                out << "... ";
                for (qint32 j = p_FiffNamedMatrix.data.cols() - ncols / 2; j < p_FiffNamedMatrix.data.cols(); ++j)
                    out << p_FiffNamedMatrix.data(i, j) << " ";
                out << "\n\t";
            }
        }
        out << "\n";
    }
 
    return out;
}
 
//=============================================================================================================
 
inline bool operator==(const FiffNamedMatrix& a, const FiffNamedMatrix& b)
{
    return (a.nrow == b.nrow &&
            a.ncol == b.ncol &&
            a.row_names == b.row_names &&
            a.col_names == b.col_names &&
            a.data.isApprox(b.data, 0.0001));
}
} // NAMESPACE
 
#endif // FIFF_NAMED_MATRIX_H