#include <VerticalBlockMatrix.h>

Public Types
typedef Eigen::Block< Matrix >	Block

typedef Eigen::Block< const Matrix >	constBlock

typedef VerticalBlockMatrix	This

Public Member Functions
DenseIndex	cols () const
	Column size. More...

const DenseIndex &	firstBlock () const

DenseIndex &	firstBlock ()

Block	full ()

const constBlock	full () const

const Matrix &	matrix () const

Matrix &	matrix ()

DenseIndex	nBlocks () const
	Block count. More...

DenseIndex	offset (DenseIndex block) const

Block	operator() (DenseIndex block)

const constBlock	operator() (DenseIndex block) const

Block	range (DenseIndex startBlock, DenseIndex endBlock)

const constBlock	range (DenseIndex startBlock, DenseIndex endBlock) const

const DenseIndex &	rowEnd () const

DenseIndex &	rowEnd ()

DenseIndex	rows () const
	Row size. More...

const DenseIndex &	rowStart () const

DenseIndex &	rowStart ()

	VerticalBlockMatrix ()

template<typename CONTAINER >
	VerticalBlockMatrix (const CONTAINER &dimensions, DenseIndex height, bool appendOneDimension=false)

template<typename CONTAINER , typename DERIVED >
	VerticalBlockMatrix (const CONTAINER &dimensions, const Eigen::MatrixBase< DERIVED > &matrix, bool appendOneDimension=false)

template<typename ITERATOR >
	VerticalBlockMatrix (ITERATOR firstBlockDim, ITERATOR lastBlockDim, DenseIndex height, bool appendOneDimension=false)

Static Public Member Functions
static VerticalBlockMatrix	LikeActiveViewOf (const VerticalBlockMatrix &rhs)

static VerticalBlockMatrix	LikeActiveViewOf (const SymmetricBlockMatrix &rhs, DenseIndex height)

Protected Member Functions
void	assertInvariants () const

void	checkBlock (DenseIndex block) const

template<typename ITERATOR >
void	fillOffsets (ITERATOR firstBlockDim, ITERATOR lastBlockDim, bool appendOneDimension)

Protected Attributes
DenseIndex	blockStart_
	Changes apparent matrix view, see main class comment. More...

Matrix	matrix_
	The full matrix. More...

DenseIndex	rowEnd_
	Changes apparent matrix view, see main class comment. More...

DenseIndex	rowStart_
	Changes apparent matrix view, see main class comment. More...

FastVector< DenseIndex >	variableColOffsets_
	the starting columns of each block (0-based) More...

Friends
class	SymmetricBlockMatrix

Detailed Description

This class stores a dense matrix and allows it to be accessed as a collection of vertical blocks. The dimensions of the blocks are provided when constructing this class.

This class also has three parameters that can be changed after construction that change the apparent view of the matrix without any reallocation or data copying. firstBlock() determines the block that has index 0 for all operations (except for re-setting firstBlock()). rowStart() determines the apparent first row of the matrix for all operations (except for setting rowStart() and rowEnd()). rowEnd() determines the apparent exclusive (one-past-the-last) last row for all operations. To include all rows, rowEnd() should be set to the number of rows in the matrix (i.e. one after the last true row index).

Definition at line 42 of file VerticalBlockMatrix.h.

Member Typedef Documentation

◆ Block

typedef Eigen::Block<Matrix> gtsam::VerticalBlockMatrix::Block

Definition at line 46 of file VerticalBlockMatrix.h.

◆ constBlock

typedef Eigen::Block<const Matrix> gtsam::VerticalBlockMatrix::constBlock

Definition at line 47 of file VerticalBlockMatrix.h.

◆ This

typedef VerticalBlockMatrix gtsam::VerticalBlockMatrix::This

Definition at line 45 of file VerticalBlockMatrix.h.

Constructor & Destructor Documentation

◆ VerticalBlockMatrix() [1/4]

gtsam::VerticalBlockMatrix::VerticalBlockMatrix ( )

inline

Construct an empty VerticalBlockMatrix

Definition at line 60 of file VerticalBlockMatrix.h.

◆ VerticalBlockMatrix() [2/4]

template<typename CONTAINER >

gtsam::VerticalBlockMatrix::VerticalBlockMatrix	(	const CONTAINER &	dimensions,
		DenseIndex	height,
		bool	appendOneDimension = `false`
	)

inline

Construct from a container of the sizes of each vertical block.

Definition at line 69 of file VerticalBlockMatrix.h.

◆ VerticalBlockMatrix() [3/4]

template<typename CONTAINER , typename DERIVED >

gtsam::VerticalBlockMatrix::VerticalBlockMatrix	(	const CONTAINER &	dimensions,
		const Eigen::MatrixBase< DERIVED > &	matrix,
		bool	appendOneDimension = `false`
	)

inline

Construct from a container of the sizes of each vertical block and a pre-prepared matrix.

Definition at line 80 of file VerticalBlockMatrix.h.

◆ VerticalBlockMatrix() [4/4]

template<typename ITERATOR >

gtsam::VerticalBlockMatrix::VerticalBlockMatrix	(	ITERATOR	firstBlockDim,
		ITERATOR	lastBlockDim,
		DenseIndex	height,
		bool	appendOneDimension = `false`
	)

inline

Construct from iterator over the sizes of each vertical block.

Definition at line 93 of file VerticalBlockMatrix.h.

Member Function Documentation

◆ assertInvariants()

void gtsam::VerticalBlockMatrix::assertInvariants ( ) const

inlineprotected

Definition at line 194 of file VerticalBlockMatrix.h.

◆ checkBlock()

void gtsam::VerticalBlockMatrix::checkBlock ( DenseIndex block ) const

inlineprotected

Definition at line 202 of file VerticalBlockMatrix.h.

◆ cols()

DenseIndex gtsam::VerticalBlockMatrix::cols ( void ) const

inline

Column size.

Definition at line 118 of file VerticalBlockMatrix.h.

◆ fillOffsets()

template<typename ITERATOR >

void gtsam::VerticalBlockMatrix::fillOffsets	(	ITERATOR	firstBlockDim,
		ITERATOR	lastBlockDim,
		bool	appendOneDimension
	)

inlineprotected

Definition at line 210 of file VerticalBlockMatrix.h.

◆ firstBlock() [1/2]

const DenseIndex& gtsam::VerticalBlockMatrix::firstBlock ( ) const

inline

Get the apparent first block for all operations

Definition at line 182 of file VerticalBlockMatrix.h.

◆ firstBlock() [2/2]

DenseIndex& gtsam::VerticalBlockMatrix::firstBlock ( )

inline

Get or set the apparent first block for all operations

Definition at line 185 of file VerticalBlockMatrix.h.

◆ full() [1/2]

Block gtsam::VerticalBlockMatrix::full ( )

inline

Return the full matrix, not including any portions excluded by rowStart(), rowEnd(), and firstBlock()

Definition at line 157 of file VerticalBlockMatrix.h.

◆ full() [2/2]

const constBlock gtsam::VerticalBlockMatrix::full ( ) const

inline

Return the full matrix, not including any portions excluded by rowStart(), rowEnd(), and firstBlock()

Definition at line 160 of file VerticalBlockMatrix.h.

◆ LikeActiveViewOf() [1/2]

VerticalBlockMatrix gtsam::VerticalBlockMatrix::LikeActiveViewOf ( const VerticalBlockMatrix & rhs )

static

Copy the block structure and resize the underlying matrix, but do not copy the matrix data. If blockStart(), rowStart(), and/or rowEnd() have been modified, this copies the structure of the corresponding matrix view. In the destination VerticalBlockView, blockStart() and rowStart() will thus be 0, rowEnd() will be cols() of the source VerticalBlockView, and the underlying matrix will be the size of the view of the source matrix.

Definition at line 25 of file VerticalBlockMatrix.cpp.

◆ LikeActiveViewOf() [2/2]

VerticalBlockMatrix gtsam::VerticalBlockMatrix::LikeActiveViewOf	(	const SymmetricBlockMatrix &	rhs,
		DenseIndex	height
	)

static

Copy the block structure, but do not copy the matrix data. If blockStart() has been modified, this copies the structure of the corresponding matrix view. In the destination VerticalBlockMatrix, blockStart() will be 0.

Definition at line 39 of file VerticalBlockMatrix.cpp.

◆ matrix() [1/2]

const Matrix& gtsam::VerticalBlockMatrix::matrix ( ) const

inline

Access to full matrix (including any portions excluded by rowStart(), rowEnd(), and firstBlock())

Definition at line 188 of file VerticalBlockMatrix.h.

◆ matrix() [2/2]

Matrix& gtsam::VerticalBlockMatrix::matrix ( )

inline

Non-const access to full matrix (including any portions excluded by rowStart(), rowEnd(), and firstBlock())

Definition at line 191 of file VerticalBlockMatrix.h.

◆ nBlocks()

DenseIndex gtsam::VerticalBlockMatrix::nBlocks ( ) const

inline

Block count.

Definition at line 121 of file VerticalBlockMatrix.h.

◆ offset()

DenseIndex gtsam::VerticalBlockMatrix::offset ( DenseIndex block ) const

inline

Definition at line 162 of file VerticalBlockMatrix.h.

◆ operator()() [1/2]

Block gtsam::VerticalBlockMatrix::operator() ( DenseIndex block )

inline

Access a single block in the underlying matrix with read/write access

Definition at line 124 of file VerticalBlockMatrix.h.

◆ operator()() [2/2]

const constBlock gtsam::VerticalBlockMatrix::operator() ( DenseIndex block ) const

inline

Access a const block view

Definition at line 127 of file VerticalBlockMatrix.h.

◆ range() [1/2]

Block gtsam::VerticalBlockMatrix::range	(	DenseIndex	startBlock,
		DenseIndex	endBlock
	)

inline

access ranges of blocks at a time

Definition at line 130 of file VerticalBlockMatrix.h.

◆ range() [2/2]

const constBlock gtsam::VerticalBlockMatrix::range	(	DenseIndex	startBlock,
		DenseIndex	endBlock
	)		const

inline

Definition at line 143 of file VerticalBlockMatrix.h.

◆ rowEnd() [1/2]

const DenseIndex& gtsam::VerticalBlockMatrix::rowEnd ( ) const

inline

Get the apparent last row (exclusive, i.e. rows() == rowEnd() - rowStart()) of the underlying matrix for all operations

Definition at line 176 of file VerticalBlockMatrix.h.

◆ rowEnd() [2/2]

DenseIndex& gtsam::VerticalBlockMatrix::rowEnd ( )

inline

Get or set the apparent last row (exclusive, i.e. rows() == rowEnd() - rowStart()) of the underlying matrix for all operations

Definition at line 179 of file VerticalBlockMatrix.h.

◆ rows()

DenseIndex gtsam::VerticalBlockMatrix::rows ( void ) const

inline

Row size.

Definition at line 115 of file VerticalBlockMatrix.h.

◆ rowStart() [1/2]

const DenseIndex& gtsam::VerticalBlockMatrix::rowStart ( ) const

inline

Get the apparent first row of the underlying matrix for all operations

Definition at line 170 of file VerticalBlockMatrix.h.

◆ rowStart() [2/2]

DenseIndex& gtsam::VerticalBlockMatrix::rowStart ( )

inline

Get or set the apparent first row of the underlying matrix for all operations

Definition at line 173 of file VerticalBlockMatrix.h.

Friends And Related Function Documentation

◆ SymmetricBlockMatrix

friend class SymmetricBlockMatrix

friend

Definition at line 219 of file VerticalBlockMatrix.h.

Member Data Documentation

◆ blockStart_

DenseIndex gtsam::VerticalBlockMatrix::blockStart_

protected

Changes apparent matrix view, see main class comment.

Definition at line 55 of file VerticalBlockMatrix.h.

◆ matrix_

Matrix gtsam::VerticalBlockMatrix::matrix_

protected

The full matrix.

Definition at line 50 of file VerticalBlockMatrix.h.

◆ rowEnd_

DenseIndex gtsam::VerticalBlockMatrix::rowEnd_

protected

Changes apparent matrix view, see main class comment.

Definition at line 54 of file VerticalBlockMatrix.h.

◆ rowStart_

DenseIndex gtsam::VerticalBlockMatrix::rowStart_

protected

Changes apparent matrix view, see main class comment.

Definition at line 53 of file VerticalBlockMatrix.h.

◆ variableColOffsets_

FastVector<DenseIndex> gtsam::VerticalBlockMatrix::variableColOffsets_

protected

the starting columns of each block (0-based)

Definition at line 51 of file VerticalBlockMatrix.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Block

◆ constBlock

◆ This

Constructor & Destructor Documentation

◆ VerticalBlockMatrix() [1/4]

◆ VerticalBlockMatrix() [2/4]

◆ VerticalBlockMatrix() [3/4]

◆ VerticalBlockMatrix() [4/4]

Member Function Documentation

◆ assertInvariants()

◆ checkBlock()

◆ cols()

◆ fillOffsets()

◆ firstBlock() [1/2]

◆ firstBlock() [2/2]

◆ full() [1/2]

◆ full() [2/2]

◆ LikeActiveViewOf() [1/2]

◆ LikeActiveViewOf() [2/2]

◆ matrix() [1/2]

◆ matrix() [2/2]

◆ nBlocks()

◆ offset()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ range() [1/2]

◆ range() [2/2]

◆ rowEnd() [1/2]

◆ rowEnd() [2/2]

◆ rows()

◆ rowStart() [1/2]

◆ rowStart() [2/2]

Friends And Related Function Documentation

◆ SymmetricBlockMatrix

Member Data Documentation

◆ blockStart_

◆ matrix_

◆ rowEnd_

◆ rowStart_

◆ variableColOffsets_