USGS

Isis 3.0 Object Programmers' Reference

Home

Isis::SparseBlockColumnMatrix Class Reference

SparseBlockColumnMatrix. More...

#include <SparseBlockMatrix.h>

Inheritance diagram for Isis::SparseBlockColumnMatrix:
Inheritance graph
Collaboration diagram for Isis::SparseBlockColumnMatrix:
Collaboration graph

Public Member Functions

 ~SparseBlockColumnMatrix ()
 Destructor.
 
 SparseBlockColumnMatrix (const SparseBlockColumnMatrix &src)
 Copy constructor.
 
SparseBlockColumnMatrixoperator= (const SparseBlockColumnMatrix &src)
 "Equals" operator.
 
void wipe ()
 Deletes all pointer elements and removes them from the map.
 
void copy (const SparseBlockColumnMatrix &src)
 Copy method.
 
void zeroBlocks ()
 Sets all elements of all matrix blocks to zero.
 
bool InsertMatrixBlock (int nColumnBlock, int nRows, int nCols)
 Inserts a "newed" boost matrix<double>* of size (nRows, nCols) into the map with the block column number as key.
 
int numberOfElements ()
 Returns total number of matrix elements in map (NOTE: NOT the number of matrix blocks).
 
int numberOfRows ()
 Returns total number of rows in map (this needs to be clarified and maybe rewritten) its the number of rows in the block on the diagonal (the last one in the column).
 
int numberOfColumns ()
 Returns total number of columns in map (NOTE: NOT the number of matrix blocks).
 
void print (std::ostream &outstream)
 Prints matrix blocks to std output stream out for debugging.
 

Detailed Description

SparseBlockColumnMatrix.

This class is bla bla bla.

Author
2011-07-29 Ken Edmundson
History:

2011-07-29 Ken Edmundson Created

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

Definition at line 48 of file SparseBlockMatrix.h.

Constructor & Destructor Documentation

Isis::SparseBlockColumnMatrix::~SparseBlockColumnMatrix ( )

Destructor.

See description of wipe method below.

Definition at line 22 of file SparseBlockMatrix.cpp.

Isis::SparseBlockColumnMatrix::SparseBlockColumnMatrix ( const SparseBlockColumnMatrix src)

Copy constructor.

Calls copy method immediately below.

Definition at line 41 of file SparseBlockMatrix.cpp.

Member Function Documentation

void Isis::SparseBlockColumnMatrix::copy ( const SparseBlockColumnMatrix src)

Copy method.

Definition at line 49 of file SparseBlockMatrix.cpp.

bool Isis::SparseBlockColumnMatrix::InsertMatrixBlock ( int  nColumnBlock,
int  nRows,
int  nCols 
)

Inserts a "newed" boost matrix<double>* of size (nRows, nCols) into the map with the block column number as key.

The matrix::clear call initializes the matrix elements to zero. If an entry exists at the key nColumnBlock, no insertion is made.

Parameters
nColumnBlockblock column number of inserted matrix (key into map)
nRowsnumber of rows in matrix to be inserted
nColsnumber of columns in matrix to be inserted

Definition at line 91 of file SparseBlockMatrix.cpp.

Referenced by Isis::BundleAdjust::formNormals1_CHOLMOD(), and Isis::operator>>().

int Isis::SparseBlockColumnMatrix::numberOfColumns ( )

Returns total number of columns in map (NOTE: NOT the number of matrix blocks).

Definition at line 139 of file SparseBlockMatrix.cpp.

Referenced by Isis::BundleAdjust::errorPropagation_CHOLMOD().

int Isis::SparseBlockColumnMatrix::numberOfElements ( )

Returns total number of matrix elements in map (NOTE: NOT the number of matrix blocks).

The sum of all the elements of all the matrix blocks.

Definition at line 118 of file SparseBlockMatrix.cpp.

int Isis::SparseBlockColumnMatrix::numberOfRows ( )

Returns total number of rows in map (this needs to be clarified and maybe rewritten) its the number of rows in the block on the diagonal (the last one in the column).

Definition at line 162 of file SparseBlockMatrix.cpp.

Referenced by Isis::BundleAdjust::errorPropagation_CHOLMOD().

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

"Equals" operator.

Definition at line 71 of file SparseBlockMatrix.cpp.

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

Prints matrix blocks to std output stream out for debugging.

Definition at line 182 of file SparseBlockMatrix.cpp.

Referenced by Isis::SparseBlockMatrix::print().

void Isis::SparseBlockColumnMatrix::wipe ( )

Deletes all pointer elements and removes them from the map.

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

Definition at line 32 of file SparseBlockMatrix.cpp.

Referenced by Isis::BundleAdjust::formNormalEquations_CHOLMOD().

void Isis::SparseBlockColumnMatrix::zeroBlocks ( )

Sets all elements of all matrix blocks to zero.

Definition at line 206 of file SparseBlockMatrix.cpp.


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