MNE-CPP  beta 1.0
Public Types | Public Member Functions | Public Attributes | Friends | List of all members
FIFFLIB::FiffNamedMatrix Class Reference

A named matrix. More...

#include <fiff_named_matrix.h>

Inheritance diagram for FIFFLIB::FiffNamedMatrix:

Public Types

typedef QSharedPointer< FiffNamedMatrixSPtr
 
typedef QSharedPointer< const FiffNamedMatrixConstSPtr
 
typedef QSharedDataPointer< FiffNamedMatrixSDPtr
 

Public Member Functions

 FiffNamedMatrix ()
 
 FiffNamedMatrix (fiff_int_t p_nrow, fiff_int_t p_ncol, const QStringList &p_row_names, const QStringList &p_col_names, const MatrixXd &p_data)
 
 FiffNamedMatrix (const FiffNamedMatrix &p_FiffNamedMatrix)
 
 ~FiffNamedMatrix ()
 
void clear ()
 
bool isEmpty () const
 
void transpose_named_matrix ()
 

Public Attributes

fiff_int_t nrow
 
fiff_int_t ncol
 
QStringList row_names
 
QStringList col_names
 
MatrixXd data
 

Friends

std::ostream & operator<< (std::ostream &out, const FIFFLIB::FiffNamedMatrix &p_FiffNamedMatrix)
 

Detailed Description

A named matrix.

A matrix with named rows and cols. ToDo: derive this from Eigen::Matrix

Definition at line 94 of file fiff_named_matrix.h.

Member Typedef Documentation

Const shared pointer type for FiffNamedMatrix.

Definition at line 98 of file fiff_named_matrix.h.

typedef QSharedDataPointer<FiffNamedMatrix> FIFFLIB::FiffNamedMatrix::SDPtr

Shared data pointer type for FiffNamedMatrix.

Definition at line 99 of file fiff_named_matrix.h.

Shared pointer type for FiffNamedMatrix.

Definition at line 97 of file fiff_named_matrix.h.

Constructor & Destructor Documentation

FiffNamedMatrix::FiffNamedMatrix ( )

Default constructor.

Definition at line 57 of file fiff_named_matrix.cpp.

FiffNamedMatrix::FiffNamedMatrix ( fiff_int_t  p_nrow,
fiff_int_t  p_ncol,
const QStringList &  p_row_names,
const QStringList &  p_col_names,
const MatrixXd &  p_data 
)
explicit

Constructs named matrix with given parameters. (No plausibility check is performed)

Parameters
[in]p_nrowNumber of rows
[in]p_ncolNumber of cols
[in]p_row_namesRow names
[in]p_col_namesColumn names
[in]p_dataData of the named matrix

Definition at line 66 of file fiff_named_matrix.cpp.

FiffNamedMatrix::FiffNamedMatrix ( const FiffNamedMatrix p_FiffNamedMatrix)

Copy constructor.

Parameters
[in]p_FiffNamedMatrixNamed matrix which should be copied

Definition at line 78 of file fiff_named_matrix.cpp.

FiffNamedMatrix::~FiffNamedMatrix ( )

Destroys the named matrix.

Definition at line 91 of file fiff_named_matrix.cpp.

Member Function Documentation

void FiffNamedMatrix::clear ( )

Initializes the named matrix.

Definition at line 99 of file fiff_named_matrix.cpp.

bool FIFFLIB::FiffNamedMatrix::isEmpty ( ) const
inline

Returns true if named matrix contains no data.

Returns
true if named matrix is empty.

Definition at line 209 of file fiff_named_matrix.h.

void FiffNamedMatrix::transpose_named_matrix ( )

MNE toolbox root function ###: Implementation of the mne_transpose_named_matrix function

Transpose a named matrix (FiffNamedMatrix)

Definition at line 111 of file fiff_named_matrix.cpp.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  out,
const FIFFLIB::FiffNamedMatrix p_FiffNamedMatrix 
)
friend

Assignment Operator

Returns
rhs named matrix which hould be assigned. overloading the stream out operator<<
Parameters
[in]outThe stream to which the fiff projector should be assigned to.
[in]p_FiffNamedMatrixFiff named matrix which should be assigned to the stream.
Returns
the stream with the attached fiff named matrix

< Matrix data

Definition at line 217 of file fiff_named_matrix.h.

Member Data Documentation

QStringList FIFFLIB::FiffNamedMatrix::col_names

Column names

Definition at line 183 of file fiff_named_matrix.h.

MatrixXd FIFFLIB::FiffNamedMatrix::data

Matrix data

Definition at line 184 of file fiff_named_matrix.h.

fiff_int_t FIFFLIB::FiffNamedMatrix::ncol

Number of columns

Definition at line 181 of file fiff_named_matrix.h.

fiff_int_t FIFFLIB::FiffNamedMatrix::nrow

Number of rows

Definition at line 180 of file fiff_named_matrix.h.

QStringList FIFFLIB::FiffNamedMatrix::row_names

Row names

Definition at line 182 of file fiff_named_matrix.h.


The documentation for this class was generated from the following files: