FIFF sparse matrix storage. More...

#include <fiff_sparse_matrix.h>

Public Types
using	SPtr = QSharedPointer<FiffSparseMatrix>
using	ConstSPtr = QSharedPointer<const FiffSparseMatrix>
using	UPtr = std::unique_ptr<FiffSparseMatrix>
using	ConstUPtr = std::unique_ptr<const FiffSparseMatrix>

Public Member Functions
	FiffSparseMatrix ()
	FiffSparseMatrix (const FiffSparseMatrix &mat)=default
	FiffSparseMatrix (FiffSparseMatrix &&mat)=default
FiffSparseMatrix &	operator= (const FiffSparseMatrix &)=default
FiffSparseMatrix &	operator= (FiffSparseMatrix &&)=default
	~FiffSparseMatrix ()=default
FiffSparseMatrix::UPtr	mne_add_upper_triangle_rcs ()
FiffSparseMatrix::UPtr	pickLowerTriangleRcs () const
bool	is_empty () const
Eigen::SparseMatrix< double >	toEigenSparse () const

Static Public Member Functions
static std::vector< int >	fiff_get_matrix_sparse_dims (const FIFFLIB::FiffTag::UPtr &tag)
static FiffSparseMatrix::UPtr	fiff_get_float_sparse_matrix (const FIFFLIB::FiffTag::UPtr &tag)
static FiffSparseMatrix::UPtr	create_sparse_rcs (int nrow, int ncol, int nnz, int colindex, float *vals)
static FiffSparseMatrix	fromEigenSparse (const Eigen::SparseMatrix< double > &mat)

Public Attributes
FIFFLIB::fiff_int_t	coding
FIFFLIB::fiff_int_t	m
FIFFLIB::fiff_int_t	n
FIFFLIB::fiff_int_t	nz
Eigen::VectorXf	data
Eigen::VectorXi	inds
Eigen::VectorXi	ptrs

Detailed Description

FIFF sparse matrix storage.

Implements a FIFF sparse matrix.

Definition at line 81 of file fiff_sparse_matrix.h.

Member Typedef Documentation

◆ ConstSPtr

using FIFFLIB::FiffSparseMatrix::ConstSPtr = QSharedPointer<const FiffSparseMatrix>

Const shared pointer type for FiffSparseMatrix.

Definition at line 85 of file fiff_sparse_matrix.h.

◆ ConstUPtr

using FIFFLIB::FiffSparseMatrix::ConstUPtr = std::unique_ptr<const FiffSparseMatrix>

Const unique pointer type for FiffSparseMatrix.

Definition at line 87 of file fiff_sparse_matrix.h.

◆ SPtr

using FIFFLIB::FiffSparseMatrix::SPtr = QSharedPointer<FiffSparseMatrix>

Shared pointer type for FiffSparseMatrix.

Definition at line 84 of file fiff_sparse_matrix.h.

◆ UPtr

using FIFFLIB::FiffSparseMatrix::UPtr = std::unique_ptr<FiffSparseMatrix>

Unique pointer type for FiffSparseMatrix.

Definition at line 86 of file fiff_sparse_matrix.h.

Constructor & Destructor Documentation

◆ FiffSparseMatrix() [1/3]

FiffSparseMatrix::FiffSparseMatrix ( )

Constructs the FiffSparseMatrix

Definition at line 145 of file fiff_sparse_matrix.cpp.

◆ FiffSparseMatrix() [2/3]

FIFFLIB::FiffSparseMatrix::FiffSparseMatrix ( const FiffSparseMatrix & mat )

default

Copies a FiffSparseMatrix (default — Eigen vectors handle deep copy).

◆ FiffSparseMatrix() [3/3]

FIFFLIB::FiffSparseMatrix::FiffSparseMatrix ( FiffSparseMatrix && mat )

default

Default move constructor.

◆ ~FiffSparseMatrix()

FIFFLIB::FiffSparseMatrix::~FiffSparseMatrix ( )

default

Destroys the FiffSparseMatrix (default — Eigen vectors clean up automatically).

Member Function Documentation

◆ create_sparse_rcs()

FiffSparseMatrix::UPtr FiffSparseMatrix::create_sparse_rcs	(	int	nrow,
		int	ncol,
		int *	nnz,
		int **	colindex,
		float **	vals )

static

Create a sparse RCS matrix from row-based data.

Parameters

[in]	nrow	Number of rows.
[in]	ncol	Number of columns.
[in]	nnz	Number of non-zero elements on each row.
[in]	colindex	Column indices of non-zero elements on each row.
[in]	vals	Values of non-zero elements on each row.

Returns: A unique pointer to the newly constructed FiffSparseMatrix, or nullptr on error.

Definition at line 226 of file fiff_sparse_matrix.cpp.

◆ fiff_get_float_sparse_matrix()

FiffSparseMatrix::UPtr FiffSparseMatrix::fiff_get_float_sparse_matrix ( const FIFFLIB::FiffTag::UPtr & tag )

static

Conversion of tag data into the standard sparse representation.

Parameters

[in] tag The tag containing sparse matrix data.

Returns: A unique pointer to the newly constructed FiffSparseMatrix, or nullptr on error.

Definition at line 162 of file fiff_sparse_matrix.cpp.

◆ fiff_get_matrix_sparse_dims()

std::vector< int > FiffSparseMatrix::fiff_get_matrix_sparse_dims ( const FIFFLIB::FiffTag::UPtr & tag )

static

Interpret dimensions and nz from matrix data.

Parameters

[in] tag The tag containing sparse matrix data.

Returns: A vector with the matrix dimension info, or empty on error.

Definition at line 155 of file fiff_sparse_matrix.cpp.

◆ fromEigenSparse()

FiffSparseMatrix FiffSparseMatrix::fromEigenSparse ( const Eigen::SparseMatrix< double > & mat )

static

Create a FiffSparseMatrix from an Eigen::SparseMatrix. Stores in RCS (row-compressed) format.

Parameters

[in] mat The Eigen sparse matrix to convert.

Returns: The equivalent FiffSparseMatrix.

Definition at line 370 of file fiff_sparse_matrix.cpp.

◆ is_empty()

bool FIFFLIB::FiffSparseMatrix::is_empty ( ) const

inline

Check whether this sparse matrix is empty (no non-zero elements).

Returns: true if the matrix has no data.

Definition at line 218 of file fiff_sparse_matrix.h.

◆ mne_add_upper_triangle_rcs()

FiffSparseMatrix::UPtr FiffSparseMatrix::mne_add_upper_triangle_rcs ( )

Add the upper triangle to a lower-triangular sparse RCS matrix.

Returns: A unique pointer to the newly constructed FiffSparseMatrix with both triangles.

Definition at line 274 of file fiff_sparse_matrix.cpp.

◆ operator=() [1/2]

FiffSparseMatrix & FIFFLIB::FiffSparseMatrix::operator= ( const FiffSparseMatrix & )

default

Default copy-assignment operator.

◆ operator=() [2/2]

FiffSparseMatrix & FIFFLIB::FiffSparseMatrix::operator= ( FiffSparseMatrix && )

default

Default move-assignment operator.

◆ pickLowerTriangleRcs()

FiffSparseMatrix::UPtr FiffSparseMatrix::pickLowerTriangleRcs ( ) const

Extract only the lower triangle (including diagonal) from a square RCS matrix.

Returns: A unique pointer to the newly constructed FiffSparseMatrix with lower-triangle elements.

Definition at line 421 of file fiff_sparse_matrix.cpp.

◆ toEigenSparse()

Eigen::SparseMatrix< double > FiffSparseMatrix::toEigenSparse ( ) const

Convert this FiffSparseMatrix to an Eigen::SparseMatrix<double>. Supports both RCS and CCS coding.

Returns: The equivalent Eigen sparse matrix.

Definition at line 337 of file fiff_sparse_matrix.cpp.

Member Data Documentation

◆ coding

FIFFLIB::fiff_int_t FIFFLIB::FiffSparseMatrix::coding

coding (storage) type of the sparse matrix.

Definition at line 204 of file fiff_sparse_matrix.h.

◆ data

Eigen::VectorXf FIFFLIB::FiffSparseMatrix::data

Non-zero values (nz elements).

Definition at line 208 of file fiff_sparse_matrix.h.

◆ inds

Eigen::VectorXi FIFFLIB::FiffSparseMatrix::inds

Index array (nz elements).

Definition at line 209 of file fiff_sparse_matrix.h.

◆ m

FIFFLIB::fiff_int_t FIFFLIB::FiffSparseMatrix::m

m rows.

Definition at line 205 of file fiff_sparse_matrix.h.

◆ n

FIFFLIB::fiff_int_t FIFFLIB::FiffSparseMatrix::n

n columns.

Definition at line 206 of file fiff_sparse_matrix.h.

◆ nz

FIFFLIB::fiff_int_t FIFFLIB::FiffSparseMatrix::nz

nz nonzeros.

Definition at line 207 of file fiff_sparse_matrix.h.

◆ ptrs

Eigen::VectorXi FIFFLIB::FiffSparseMatrix::ptrs

Pointer array (m+1 for RCS, n+1 for CCS).

Definition at line 210 of file fiff_sparse_matrix.h.

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

src/libraries/fiff/fiff_sparse_matrix.h
src/libraries/fiff/fiff_sparse_matrix.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ ConstSPtr

◆ ConstUPtr

◆ SPtr

◆ UPtr

Constructor & Destructor Documentation

◆ FiffSparseMatrix() [1/3]

◆ FiffSparseMatrix() [2/3]

◆ FiffSparseMatrix() [3/3]

◆ ~FiffSparseMatrix()

Member Function Documentation

◆ create_sparse_rcs()

◆ fiff_get_float_sparse_matrix()

◆ fiff_get_matrix_sparse_dims()

◆ fromEigenSparse()

◆ is_empty()

◆ mne_add_upper_triangle_rcs()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ pickLowerTriangleRcs()

◆ toEigenSparse()

Member Data Documentation

◆ coding

◆ data

◆ inds

◆ m

◆ n

◆ nz

◆ ptrs