USGS

Isis 3.0 Developer's Reference (API)

Home

Isis::SparseBlockRowMatrix Class Reference

SparseBlockRowMatrix. More...

#include <SparseBlockMatrix.h>

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

Public Member Functions

 SparseBlockRowMatrix ()
 
 ~SparseBlockRowMatrix ()
 Destructor.
 
 SparseBlockRowMatrix (const SparseBlockRowMatrix &src)
 Copy constructor.
 
SparseBlockRowMatrixoperator= (const SparseBlockRowMatrix &src)
 "Equals" operator.
 
void wipe ()
 Deletes all pointer elements and removes them from the map.
 
void copy (const SparseBlockRowMatrix &src)
 Copy method.
 
void zeroBlocks ()
 Sets all elements of all matrix blocks to zero.
 
bool InsertMatrixBlock (int nRowBlock, int nRows, int nCols)
 Inserts a "newed" boost matrix<double>* of size (nRows, nCols) into the map with the block row number as key.
 
void copyToBoost (boost::numeric::ublas::compressed_matrix< double > &B)
 Copies a SparseBlockRowMatrix to a Boost compressed_matrix This may be a temporary implementation.
 
int numberOfElements ()
 Returns total number of matrix elements 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

SparseBlockRowMatrix.

This class is bla bla bla.

Author
2011-07-29 Ken Edmundson

Constructor & Destructor Documentation

Isis::SparseBlockRowMatrix::SparseBlockRowMatrix ( )
inline
Isis::SparseBlockRowMatrix::~SparseBlockRowMatrix ( )

Destructor.

See description of wipe method below.

Isis::SparseBlockRowMatrix::SparseBlockRowMatrix ( const SparseBlockRowMatrix src)

Copy constructor.

Calls method immediately below.

Member Function Documentation

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

Copy method.

void Isis::SparseBlockRowMatrix::copyToBoost ( boost::numeric::ublas::compressed_matrix< double > &  B)

Copies a SparseBlockRowMatrix to a Boost compressed_matrix This may be a temporary implementation.

bool Isis::SparseBlockRowMatrix::InsertMatrixBlock ( int  nRowBlock,
int  nRows,
int  nCols 
)

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

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

Parameters
nRowBlockblock row 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::SparseBlockRowMatrix::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.

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

"Equals" operator.

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

Prints matrix blocks to std output stream out for debugging.

void Isis::SparseBlockRowMatrix::wipe ( )

Deletes all pointer elements and removes them from the map.

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

void Isis::SparseBlockRowMatrix::zeroBlocks ( )

Sets all elements of all matrix blocks to zero.


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