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

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

#include <addresskeepermatrix.h>

Collaboration diagram for AddressKeeperMatrix:
Collaboration graph

Public Member Functions

 AddressKeeperMatrix ()
 This is the default AddressKeeperMatrix constructor. More...
 
 ~AddressKeeperMatrix ()
 This is the AddressKeeperMatrix destructor. More...
 
void resize ()
 This will add one new empty entry to the vector. More...
 
int Nrow () const
 This will return the number of rows of the vector. More...
 
int Ncol (int i=0) const
 This will return the number of columns in row i of the vector. More...
 
void Delete (int pos)
 This will delete an entry from the vector. More...
 
AddressKeeperVectoroperator[] (int pos)
 This will return the value of an element of the vector. More...
 
const AddressKeeperVectoroperator[] (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...
 
AddressKeeperVector ** v
 This is the vector of AddressKeeperVector values. More...
 

Detailed Description

This class implements a dynamic vector of AddressKeeperVector values.

Constructor & Destructor Documentation

◆ AddressKeeperMatrix()

AddressKeeperMatrix::AddressKeeperMatrix ( )
inline

This is the default AddressKeeperMatrix constructor.

◆ ~AddressKeeperMatrix()

AddressKeeperMatrix::~AddressKeeperMatrix ( )

This is the AddressKeeperMatrix destructor.

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

Member Function Documentation

◆ Delete()

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

◆ Nrow()

int AddressKeeperMatrix::Nrow ( ) const
inline

This will return the number of rows of the vector.

Returns
the number of rows of the vector

◆ operator[]() [1/2]

AddressKeeperVector& AddressKeeperMatrix::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 AddressKeeperVector& AddressKeeperMatrix::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 AddressKeeperMatrix::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 AddressKeeperMatrix::nrow
protected

This is number of rows of the vector.

◆ v

AddressKeeperVector** AddressKeeperMatrix::v
protected

This is the vector of AddressKeeperVector values.


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