USGS

Isis 3.0 Developer's Reference (API)

Home

Isis::SparseBlockColumnMatrix Class Reference

SparseBlockColumnMatrix. More...

#include <SparseBlockMatrix.h>

Inherits QMap< int, boost::numeric::ublas::matrix< double > * >.

Public Member Functions

 SparseBlockColumnMatrix ()
 
 ~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

Constructor & Destructor Documentation

Isis::SparseBlockColumnMatrix::SparseBlockColumnMatrix ( )
inline
Isis::SparseBlockColumnMatrix::~SparseBlockColumnMatrix ( )

Destructor.

See description of wipe method below.

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

Copy constructor.

Calls copy method immediately below.

Member Function Documentation

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

Copy method.

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

Referenced by Isis::operator>>().

int Isis::SparseBlockColumnMatrix::numberOfColumns ( )

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

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.

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).

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

"Equals" operator.

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

Prints matrix blocks to std output stream out for debugging.

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.

void Isis::SparseBlockColumnMatrix::zeroBlocks ( )

Sets all elements of all matrix blocks to zero.


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