Gadget
Public Member Functions | Protected Attributes | List of all members
DoubleMatrixPtrMatrix Class Reference

This class implements a dynamic vector of DoubleMatrixPtrVector values. More...

#include <doublematrixptrmatrix.h>

Collaboration diagram for DoubleMatrixPtrMatrix:
Collaboration graph

Public Member Functions

 DoubleMatrixPtrMatrix ()
 This is the default DoubleMatrixPtrMatrix constructor. More...
 
 ~DoubleMatrixPtrMatrix ()
 This is the DoubleMatrixPtrMatrix destructor. More...
 
int Ncol (int i=0) const
 This will return the number of columns in row i of the vector. More...
 
int Nrow () const
 This will return the number of rows of the vector. More...
 
DoubleMatrixPtrVectoroperator[] (int pos)
 This will return the value of an element of the vector. More...
 
const DoubleMatrixPtrVectoroperator[] (int pos) const
 This will return the value of an element of the vector. More...
 
void resize ()
 This will add one new empty entry to the vector. More...
 
void Delete (int pos)
 This will delete an entry from the vector. More...
 

Protected Attributes

int nrow
 This is number of rows of the vector. More...
 
DoubleMatrixPtrVector ** v
 This is the vector of DoubleMatrixPtrVector values. More...
 

Detailed Description

This class implements a dynamic vector of DoubleMatrixPtrVector values.

Constructor & Destructor Documentation

◆ DoubleMatrixPtrMatrix()

DoubleMatrixPtrMatrix::DoubleMatrixPtrMatrix ( )
inline

This is the default DoubleMatrixPtrMatrix constructor.

◆ ~DoubleMatrixPtrMatrix()

DoubleMatrixPtrMatrix::~DoubleMatrixPtrMatrix ( )

This is the DoubleMatrixPtrMatrix destructor.

Note
This will free all the memory allocated to all the elements of the vector

Member Function Documentation

◆ Delete()

void DoubleMatrixPtrMatrix::Delete ( int  pos)

This will delete an entry from the vector.

Parameters
posis the element of the vector to be deleted
Note
This will free the memory allocated to the deleted element of the vector

◆ Ncol()

int DoubleMatrixPtrMatrix::Ncol ( int  i = 0) const
inline

This will return the number of columns in row i of the vector.

Parameters
iis the row of the vector to have the number of columns counted
Returns
the number of columns in row i of the vector
Note
This is the number of entries in the DoubleMatrixPtrVector that is entry i of the DoubleMatrixPtrMatrix

◆ Nrow()

int DoubleMatrixPtrMatrix::Nrow ( ) const
inline

This will return the number of rows of the vector.

Returns
the number of rows of the vector

◆ operator[]() [1/2]

DoubleMatrixPtrVector& DoubleMatrixPtrMatrix::operator[] ( int  pos)
inline

This will return the value of an element of the vector.

Parameters
posis the element of the vector to be returned
Returns
the value of the specified element

◆ operator[]() [2/2]

const DoubleMatrixPtrVector& DoubleMatrixPtrMatrix::operator[] ( int  pos) const
inline

This will return the value of an element of the vector.

Parameters
posis the element of the vector to be returned
Returns
the value of the specified element

◆ resize()

void DoubleMatrixPtrMatrix::resize ( )

This will add one new empty entry to the vector.

Note
The new element of the vector will be created, and set to zero

Member Data Documentation

◆ nrow

int DoubleMatrixPtrMatrix::nrow
protected

This is number of rows of the vector.

◆ v

DoubleMatrixPtrVector** DoubleMatrixPtrMatrix::v
protected

This is the vector of DoubleMatrixPtrVector values.


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