MNE-CPP  0.1.9
A Framework for Electrophysiology
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>

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 Eigen::MatrixXd &p_data)
 
 FiffNamedMatrix (const FiffNamedMatrix &p_FiffNamedMatrix)
 
 ~FiffNamedMatrix ()=default
 
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
 
Eigen::MatrixXd data
 

Friends

std::ostream & operator<< (std::ostream &out, const FIFFLIB::FiffNamedMatrix &p_FiffNamedMatrix)
 
bool operator== (const FiffNamedMatrix &a, const FiffNamedMatrix &b)
 

Detailed Description

A named matrix.

Matrix specification with named rows and cols.

Definition at line 76 of file fiff_named_matrix.h.

Inheritance diagram for FIFFLIB::FiffNamedMatrix:
Inheritance graph

Member Typedef Documentation

◆ ConstSPtr

Const shared pointer type for FiffNamedMatrix.

Definition at line 80 of file fiff_named_matrix.h.

◆ SDPtr

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

Shared data pointer type for FiffNamedMatrix.

Definition at line 81 of file fiff_named_matrix.h.

◆ SPtr

Shared pointer type for FiffNamedMatrix.

Definition at line 79 of file fiff_named_matrix.h.

Constructor & Destructor Documentation

◆ FiffNamedMatrix() [1/3]

FiffNamedMatrix::FiffNamedMatrix ( )

Default constructor.

Definition at line 54 of file fiff_named_matrix.cpp.

◆ FiffNamedMatrix() [2/3]

FIFFLIB::FiffNamedMatrix::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 
)
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.

◆ FiffNamedMatrix() [3/3]

FiffNamedMatrix::FiffNamedMatrix ( const FiffNamedMatrix p_FiffNamedMatrix)

Copy constructor.

Parameters
[in]p_FiffNamedMatrixNamed matrix which should be copied.

Definition at line 73 of file fiff_named_matrix.cpp.

◆ ~FiffNamedMatrix()

FIFFLIB::FiffNamedMatrix::~FiffNamedMatrix ( )
default

Destroys the named matrix.

Member Function Documentation

◆ clear()

void FiffNamedMatrix::clear ( )

Initializes the named matrix.

Definition at line 85 of file fiff_named_matrix.cpp.

◆ isEmpty()

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

Returns true if named matrix contains no data.

Returns
true if named matrix is empty.

Definition at line 206 of file fiff_named_matrix.h.

◆ transpose_named_matrix()

void FiffNamedMatrix::transpose_named_matrix ( )

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

Transpose a named matrix (FiffNamedMatrix)

Definition at line 96 of file fiff_named_matrix.cpp.

Friends And Related Function Documentation

◆ operator<<

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 213 of file fiff_named_matrix.h.

◆ operator==

bool operator== ( const FiffNamedMatrix a,
const FiffNamedMatrix b 
)
friend

Overloaded == operator to compare an object to this instance.

Parameters
[in]objectThe object which should be compared to.
Returns
true if equal, false otherwise.

Definition at line 293 of file fiff_named_matrix.h.

Member Data Documentation

◆ col_names

QStringList FIFFLIB::FiffNamedMatrix::col_names

Column names.

Definition at line 174 of file fiff_named_matrix.h.

◆ data

Eigen::MatrixXd FIFFLIB::FiffNamedMatrix::data

Matrix data.

Definition at line 175 of file fiff_named_matrix.h.

◆ ncol

fiff_int_t FIFFLIB::FiffNamedMatrix::ncol

Number of columns.

Definition at line 172 of file fiff_named_matrix.h.

◆ nrow

fiff_int_t FIFFLIB::FiffNamedMatrix::nrow

Number of rows.

Definition at line 171 of file fiff_named_matrix.h.

◆ row_names

QStringList FIFFLIB::FiffNamedMatrix::row_names

Row names.

Definition at line 173 of file fiff_named_matrix.h.


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