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

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

#include <agebandmatrixptrmatrix.h>

Collaboration diagram for AgeBandMatrixPtrMatrix:
Collaboration graph

Public Member Functions

 AgeBandMatrixPtrMatrix ()
 This is the default AgeBandMatrixPtrMatrix constructor. More...
 
 ~AgeBandMatrixPtrMatrix ()
 This is the AgeBandMatrixPtrMatrix destructor. More...
 
void resize (AgeBandMatrixPtrVector *value)
 This will add one new entry to the vector. More...
 
void Delete (int pos)
 This will delete an entry from the vector. 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...
 
AgeBandMatrixPtrVector *& operator[] (int pos)
 This will return the value of an element of the vector. More...
 
AgeBandMatrixPtrVector *const & operator[] (int pos) const
 This will return the value of an element of the vector. More...
 

Protected Attributes

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

Detailed Description

This class implements a dynamic vector of AgeBandMatrixPtrVector values.

Constructor & Destructor Documentation

◆ AgeBandMatrixPtrMatrix()

AgeBandMatrixPtrMatrix::AgeBandMatrixPtrMatrix ( )
inline

This is the default AgeBandMatrixPtrMatrix constructor.

◆ ~AgeBandMatrixPtrMatrix()

AgeBandMatrixPtrMatrix::~AgeBandMatrixPtrMatrix ( )

This is the AgeBandMatrixPtrMatrix destructor.

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

Member Function Documentation

◆ Delete()

void AgeBandMatrixPtrMatrix::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 AgeBandMatrixPtrMatrix::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 AgeBandMatrixPtrVector that is entry i of the AgeBandMatrixPtrMatrix

◆ Nrow()

int AgeBandMatrixPtrMatrix::Nrow ( ) const
inline

This will return the number of rows of the vector.

Returns
the number of rows of the vector

◆ operator[]() [1/2]

AgeBandMatrixPtrVector*& AgeBandMatrixPtrMatrix::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]

AgeBandMatrixPtrVector* const& AgeBandMatrixPtrMatrix::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 AgeBandMatrixPtrMatrix::resize ( AgeBandMatrixPtrVector value)

This will add one new entry to the vector.

Parameters
valueis the value that will be entered for the new entry

Member Data Documentation

◆ nrow

int AgeBandMatrixPtrMatrix::nrow
protected

This is number of rows of the vector.

◆ v

AgeBandMatrixPtrVector** AgeBandMatrixPtrMatrix::v
protected

This is the vector of AgeBandMatrixPtrVector values.


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