#include <SparseBlockMatrix.h>

Inheritance diagram for Isis::SparseBlockMatrix:

Collaboration diagram for Isis::SparseBlockMatrix:

Public Member Functions
	~SparseBlockMatrix ()
	Destructor. More...

	SparseBlockMatrix (const SparseBlockMatrix &src)
	Copy constructor. More...

SparseBlockMatrix &	operator= (const SparseBlockMatrix &src)
	"Equals" operator. More...

void	wipe ()
	Deletes all pointer elements and removes them from the list. More...

void	copy (const SparseBlockMatrix &src)
	Copy method. More...

bool	setNumberOfColumns (int n)
	Initializes number of columns (SparseBlockColumnMatrix). More...

void	zeroBlocks ()
	Sets all elements of all matrix blocks to zero. More...

bool	insertMatrixBlock (int nColumnBlock, int nRowBlock, int nRows, int nCols)
	Inserts a "newed" boost LinearAlgebra::Matrix pointer of size (nRows, nCols) into the matrix at nColumnBlock, nRowBlock. More...

LinearAlgebra::Matrix *	getBlock (int column, int row)
	Returns pointer to boost matrix at position (column, row). More...

int	numberOfBlocks ()
	Returns total number of blocks in matrix. More...

int	numberOfDiagonalBlocks ()
	Returns number of diagonal matrix blocks (equivalent to size - there is one per column). More...

int	numberOfOffDiagonalBlocks ()
	Returns number of off-diagonal matrix blocks. More...

int	numberOfElements ()
	Returns number of matrix elements in matrix. More...

void	print (std::ostream &outstream)
	Prints matrix blocks to std output stream out for debugging. More...

void	printClean (std::ostream &outstream)
	Prints matrix blocks to std output stream out for debugging. More...

bool	write (std::ofstream &fp_out, bool binary=true)

int	getLeadingColumnsForBlock (int nblockColumn)
	Sums and returns the number of columns in each matrix block prior to nblockColumn. More...

int	getLeadingRowsForBlock (int nblockRow)
	Sums and returns the number of rows in each matrix block prior to nblockRow. More...

Detailed Description

SparseBlockMatrix.

The CHOLMOD (Cholesky decomposition) package uses the compressed column storage (CCS) matrix format which is efficient in memory storage but inefficient to fill in an arbitrary manner because the insertion of every non-zero entry requires that all succeeding entries be shifted.

To build the reduced normal equations matrix, an interim sparse matrix structure is required that can be efficiently populated in a random fashion and can be traversed by column in row order to subsequently construct the CCS matrix required by CHOLMOD. We use a type of Block Compressed Column Storage (BCCS) which consists of an array of map containers (QList of SparseBlockColumnMatrices), each representing a column of square matrix blocks in the reduced normal equations. The key into each column map is the block’s row index.The value at each key is a square dense matrix (Boost matrix) with a dimension equivalent to the number of exterior orientation parameters used for the image. Zero blocks are not stored. The BCCS matrix is created only in the first iteration of the bundle adjustment; in subsequent iterations it need only be repopulated. As the normal equations matrix is symmetric, only the upper triangular portion is stored in memory.

Author: 2011-07-29 Ken Edmundson

History:: 2011-07-29 Ken Edmundson Created

History:: 2014-02-25 Ken Edmundson - operators to read/write matrices to binary disk file and to write matrices to QDebug stream.

History:: 2015-12-18 Ken Edmundson - 1) added more detailed documentation; 2) brought closer to ISIS coding standards.

Definition at line 186 of file SparseBlockMatrix.h.

Constructor & Destructor Documentation

◆ ~SparseBlockMatrix()

Isis::SparseBlockMatrix::~SparseBlockMatrix ( )

Destructor.

Definition at line 809 of file SparseBlockMatrix.cpp.

◆ SparseBlockMatrix()

Isis::SparseBlockMatrix::SparseBlockMatrix ( const SparseBlockMatrix & src )

Copy constructor.

Calls copy method immediately below.

Parameters

src	SparseBlockMatrix to copy

Definition at line 829 of file SparseBlockMatrix.cpp.

Member Function Documentation

◆ copy()

void Isis::SparseBlockMatrix::copy ( const SparseBlockMatrix & src )

Copy method.

Parameters

src	SparseBlockMatrix to copy

Definition at line 839 of file SparseBlockMatrix.cpp.

◆ getBlock()

LinearAlgebra::Matrix * Isis::SparseBlockMatrix::getBlock	(	int	column,
		int	row
	)

Returns pointer to boost matrix at position (column, row).

Parameters

column	block column number
row	block row number

Returns: LinearAlgebra::Matrix Pointer to Boost matrix at position (column, row)

Definition at line 986 of file SparseBlockMatrix.cpp.

◆ getLeadingColumnsForBlock()

int Isis::SparseBlockMatrix::getLeadingColumnsForBlock ( int nblockColumn )

Sums and returns the number of columns in each matrix block prior to nblockColumn.

Parameters

nblockColumn

Returns: int Number of leading column elements for block at nblockColumn

Definition at line 1054 of file SparseBlockMatrix.cpp.

◆ getLeadingRowsForBlock()

int Isis::SparseBlockMatrix::getLeadingRowsForBlock ( int nblockRow )

Sums and returns the number of rows in each matrix block prior to nblockRow.

Parameters

nblockRow

Returns: int Number of leading row elements for block at nblockRow

Definition at line 1088 of file SparseBlockMatrix.cpp.

◆ insertMatrixBlock()

bool Isis::SparseBlockMatrix::insertMatrixBlock	(	int	nColumnBlock,
		int	nRowBlock,
		int	nRows,
		int	nCols
	)

Inserts a "newed" boost LinearAlgebra::Matrix pointer of size (nRows, nCols) into the matrix at nColumnBlock, nRowBlock.

The inserted matrix elements are initialized to zero. If an entry exists at nColumnBlock, RowBlock, no insertion is made.

Parameters

nColumnBlock	block column number of inserted matrix (QList index)
nRowBlock	block row number of inserted matrix (key into map)
nRows	number of rows in matrix to be inserted
nCols	number of columns in matrix to be inserted

Returns: bool Returns result of SparseBlockColumnMatrix::insertMatrixBlock()

Definition at line 895 of file SparseBlockMatrix.cpp.

◆ numberOfBlocks()

int Isis::SparseBlockMatrix::numberOfBlocks ( )

Returns total number of blocks in matrix.

Returns: int Total number of blocks in matrix

Definition at line 905 of file SparseBlockMatrix.cpp.

◆ numberOfDiagonalBlocks()

int Isis::SparseBlockMatrix::numberOfDiagonalBlocks ( )

Returns number of diagonal matrix blocks (equivalent to size - there is one per column).

Returns: int Number of diagnonal blocks in matrix

Definition at line 924 of file SparseBlockMatrix.cpp.

◆ numberOfElements()

int Isis::SparseBlockMatrix::numberOfElements ( )

Returns number of matrix elements in matrix.

Returns: int Total number of matrix elements

Definition at line 963 of file SparseBlockMatrix.cpp.

◆ numberOfOffDiagonalBlocks()

int Isis::SparseBlockMatrix::numberOfOffDiagonalBlocks ( )

Returns number of off-diagonal matrix blocks.

Returns: int Number of off-diagonal blocks in matrix

Definition at line 953 of file SparseBlockMatrix.cpp.

◆ operator=()

SparseBlockMatrix & Isis::SparseBlockMatrix::operator= ( const SparseBlockMatrix & src )

"Equals" operator.

Parameters

src	SparseBlockMatrix to check against

Definition at line 855 of file SparseBlockMatrix.cpp.

◆ print()

void Isis::SparseBlockMatrix::print ( std::ostream & outstream )

Prints matrix blocks to std output stream out for debugging.

Parameters

outstream output stream

Definition at line 1005 of file SparseBlockMatrix.cpp.

References Isis::SparseBlockColumnMatrix::print().

◆ printClean()

void Isis::SparseBlockMatrix::printClean ( std::ostream & outstream )

Prints matrix blocks to std output stream out for debugging.

Parameters

outstream output stream

Definition at line 1029 of file SparseBlockMatrix.cpp.

References Isis::SparseBlockColumnMatrix::printClean().

◆ setNumberOfColumns()

bool Isis::SparseBlockMatrix::setNumberOfColumns ( int n )

Initializes number of columns (SparseBlockColumnMatrix).

Parameters

n	number of columns to insert

Returns: bool Always returns true TODO: why bother returning bool? should there be a false condition?

Definition at line 873 of file SparseBlockMatrix.cpp.

Referenced by Isis::operator>>().

◆ wipe()

void Isis::SparseBlockMatrix::wipe ( )

Deletes all pointer elements and removes them from the list.

Effectively, a destructor, and in fact, called by the ~SparseBlockMatrix above.

Definition at line 818 of file SparseBlockMatrix.cpp.

◆ zeroBlocks()

void Isis::SparseBlockMatrix::zeroBlocks ( )

Sets all elements of all matrix blocks to zero.

Definition at line 994 of file SparseBlockMatrix.cpp.

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

src/base/objs/SparseBlockMatrix/SparseBlockMatrix.h
src/base/objs/SparseBlockMatrix/SparseBlockMatrix.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~SparseBlockMatrix()

◆ SparseBlockMatrix()

Member Function Documentation

◆ copy()

◆ getBlock()

◆ getLeadingColumnsForBlock()

◆ getLeadingRowsForBlock()

◆ insertMatrixBlock()

◆ numberOfBlocks()

◆ numberOfDiagonalBlocks()

◆ numberOfElements()

◆ numberOfOffDiagonalBlocks()

◆ operator=()

◆ print()

◆ printClean()

◆ setNumberOfColumns()

◆ wipe()

◆ zeroBlocks()