Sparse matrix which uses blocks based on hash structures. More...

#include <sparse_block_matrix_ccs.h>

Public Types
typedef MatrixType	SparseMatrixBlock
	this is the type of the elementary block, it is an Eigen::Matrix.
typedef std::unordered_map< int, MatrixType * >	SparseColumn

Public Member Functions
int	cols () const
	columns of the matrix
int	rows () const
	rows of the matrix
	SparseBlockMatrixHashMap (const std::vector< int > &rowIndices, const std::vector< int > &colIndices)
int	rowsOfBlock (int r) const
	how many rows does the block at block-row r has?
int	colsOfBlock (int c) const
	how many cols does the block at block-col c has?
int	rowBaseOfBlock (int r) const
	where does the row at block-row r start?
int	colBaseOfBlock (int c) const
	where does the col at block-col r start?
const std::vector< SparseColumn > &	blockCols () const
	the block matrices per block-column
std::vector< SparseColumn > &	blockCols ()
const std::vector< int > &	rowBlockIndices () const
	indices of the row blocks
const std::vector< int > &	colBlockIndices () const
	indices of the column blocks
MatrixType *	addBlock (int r, int c, bool zeroBlock=false)

Protected Attributes
const std::vector< int > &	_rowBlockIndices
const std::vector< int > &	_colBlockIndices
	vector of the indices of the blocks along the cols
std::vector< SparseColumn >	_blockCols
	the matrices stored in CCS order

Detailed Description

template<class MatrixType>
class g2o::SparseBlockMatrixHashMap< MatrixType >

Sparse matrix which uses blocks based on hash structures.

This class is used to construct the pattern of a sparse block matrix

Definition at line 217 of file sparse_block_matrix_ccs.h.

Member Typedef Documentation

◆ SparseColumn

template<class MatrixType>

typedef std::unordered_map<int, MatrixType*> g2o::SparseBlockMatrixHashMap< MatrixType >::SparseColumn

Definition at line 231 of file sparse_block_matrix_ccs.h.

◆ SparseMatrixBlock

template<class MatrixType>

typedef MatrixType g2o::SparseBlockMatrixHashMap< MatrixType >::SparseMatrixBlock

this is the type of the elementary block, it is an Eigen::Matrix.

Definition at line 220 of file sparse_block_matrix_ccs.h.

Constructor & Destructor Documentation

◆ SparseBlockMatrixHashMap()

template<class MatrixType>

g2o::SparseBlockMatrixHashMap< MatrixType >::SparseBlockMatrixHashMap	(	const std::vector< int > &	rowIndices,
		const std::vector< int > &	colIndices )

inline

Definition at line 233 of file sparse_block_matrix_ccs.h.

References _colBlockIndices, and _rowBlockIndices.

Member Function Documentation

◆ addBlock()

template<class MatrixType>

MatrixType * g2o::SparseBlockMatrixHashMap< MatrixType >::addBlock	(	int	r,
		int	c,
		bool	zeroBlock = false )

inline

add a block to the pattern, return a pointer to the added block

Definition at line 268 of file sparse_block_matrix_ccs.h.

References _blockCols, colsOfBlock(), and rowsOfBlock().

Referenced by g2o::BlockSolver< Traits >::buildStructure().

◆ blockCols() [1/2]

template<class MatrixType>

std::vector< SparseColumn > & g2o::SparseBlockMatrixHashMap< MatrixType >::blockCols ( )

inline

Definition at line 257 of file sparse_block_matrix_ccs.h.

References _blockCols.

◆ blockCols() [2/2]

template<class MatrixType>

const std::vector< SparseColumn > & g2o::SparseBlockMatrixHashMap< MatrixType >::blockCols ( ) const

inline

the block matrices per block-column

Definition at line 256 of file sparse_block_matrix_ccs.h.

References _blockCols.

Referenced by g2o::BlockSolver< Traits >::buildStructure(), and g2o::SparseBlockMatrix< MatrixType >::takePatternFromHash().

◆ colBaseOfBlock()

template<class MatrixType>

int g2o::SparseBlockMatrixHashMap< MatrixType >::colBaseOfBlock ( int c ) const

inline

where does the col at block-col r start?

Definition at line 253 of file sparse_block_matrix_ccs.h.

References _colBlockIndices.

◆ colBlockIndices()

template<class MatrixType>

const std::vector< int > & g2o::SparseBlockMatrixHashMap< MatrixType >::colBlockIndices ( ) const

inline

indices of the column blocks

Definition at line 263 of file sparse_block_matrix_ccs.h.

References _colBlockIndices.

◆ cols()

template<class MatrixType>

int g2o::SparseBlockMatrixHashMap< MatrixType >::cols ( ) const

inline

columns of the matrix

Definition at line 223 of file sparse_block_matrix_ccs.h.

References _colBlockIndices.

◆ colsOfBlock()

template<class MatrixType>

int g2o::SparseBlockMatrixHashMap< MatrixType >::colsOfBlock ( int c ) const

inline

how many cols does the block at block-col c has?

Definition at line 244 of file sparse_block_matrix_ccs.h.

References _colBlockIndices.

Referenced by addBlock().

◆ rowBaseOfBlock()

template<class MatrixType>

int g2o::SparseBlockMatrixHashMap< MatrixType >::rowBaseOfBlock ( int r ) const

inline

where does the row at block-row r start?

Definition at line 250 of file sparse_block_matrix_ccs.h.

References _rowBlockIndices.

◆ rowBlockIndices()

template<class MatrixType>

const std::vector< int > & g2o::SparseBlockMatrixHashMap< MatrixType >::rowBlockIndices ( ) const

inline

indices of the row blocks

Definition at line 260 of file sparse_block_matrix_ccs.h.

References _rowBlockIndices.

◆ rows()

template<class MatrixType>

int g2o::SparseBlockMatrixHashMap< MatrixType >::rows ( ) const

inline

rows of the matrix

Definition at line 227 of file sparse_block_matrix_ccs.h.

References _rowBlockIndices.

◆ rowsOfBlock()

template<class MatrixType>

int g2o::SparseBlockMatrixHashMap< MatrixType >::rowsOfBlock ( int r ) const

inline

how many rows does the block at block-row r has?

Definition at line 238 of file sparse_block_matrix_ccs.h.

References _rowBlockIndices.

Referenced by addBlock().

Member Data Documentation

◆ _blockCols

template<class MatrixType>

std::vector<SparseColumn> g2o::SparseBlockMatrixHashMap< MatrixType >::_blockCols

protected

the matrices stored in CCS order

Definition at line 289 of file sparse_block_matrix_ccs.h.

Referenced by addBlock(), blockCols(), and blockCols().

◆ _colBlockIndices

template<class MatrixType>

const std::vector<int>& g2o::SparseBlockMatrixHashMap< MatrixType >::_colBlockIndices

protected

vector of the indices of the blocks along the cols

Definition at line 288 of file sparse_block_matrix_ccs.h.

Referenced by colBaseOfBlock(), colBlockIndices(), cols(), colsOfBlock(), and SparseBlockMatrixHashMap().

◆ _rowBlockIndices

template<class MatrixType>

const std::vector<int>& g2o::SparseBlockMatrixHashMap< MatrixType >::_rowBlockIndices

protected

vector of the indices of the blocks along the rows.

Definition at line 285 of file sparse_block_matrix_ccs.h.

Referenced by rowBaseOfBlock(), rowBlockIndices(), rows(), rowsOfBlock(), and SparseBlockMatrixHashMap().

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

/build/reproducible-path/g2o-0~20230806/g2o/core/sparse_block_matrix_ccs.h

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ SparseColumn

◆ SparseMatrixBlock

Constructor & Destructor Documentation

◆ SparseBlockMatrixHashMap()

Member Function Documentation

◆ addBlock()

◆ blockCols() [1/2]

◆ blockCols() [2/2]

◆ colBaseOfBlock()

◆ colBlockIndices()

◆ cols()

◆ colsOfBlock()

◆ rowBaseOfBlock()

◆ rowBlockIndices()

◆ rows()

◆ rowsOfBlock()

Member Data Documentation

◆ _blockCols

◆ _colBlockIndices

◆ _rowBlockIndices