Revision 1 -
(download)
(annotate)
Mon Feb 10 17:09:07 2014 UTC
(10 years, 5 months ago)
by agomez File size: 2907 byte(s)
Initial version based on Gadget 2.2.00
#ifndef popratiomatrix_h
#define popratiomatrix_h
#include "intvector.h"
#include "popratiovector.h"
/**
* \class PopRatioMatrix
* \brief This class implements a dynamic vector of PopRatioVector values
*/
class PopRatioMatrix {
public:
/**
* \brief This is the default PopRatioMatrix constructor
*/
PopRatioMatrix() { nrow = 0; v = 0; };
/**
* \brief This is the PopRatioMatrix constructor for a specified size
* \param nr is the size of the vector to be created
* \param nc is the length of each row to be created (ie. the size of the PopRatioVector to be created for each row)
* \param initial is the initial value for all the entries of the vector
*/
PopRatioMatrix(int nr, int nc, PopRatio initial);
/**
* \brief This is the PopRatioMatrix constructor that creates a copy of an existing PopRatioMatrix
* \param initial is the PopRatioMatrix to copy
*/
PopRatioMatrix(const PopRatioMatrix& initial);
/**
* \brief This is the PopRatioMatrix destructor
* \note This will free all the memory allocated to all the elements of the vector
*/
~PopRatioMatrix();
/**
* \brief This will return the number of columns in row i of the vector
* \param i is the row of the vector to have the number of columns counted
* \return the number of columns in row i of the vector
* \note This is the number of entries in the PopRatioVector that is entry i of the PopRatioMatrix
*/
int Ncol(int i = 0) const { return v[i]->Size(); };
/**
* \brief This will return the number of rows of the vector
* \return the number of rows of the vector
*/
int Nrow() const { return nrow; };
/**
* \brief This will return the value of an element of the vector
* \param pos is the element of the vector to be returned
* \return the value of the specified element
*/
PopRatioVector& operator [] (int pos) { return *v[pos]; };
/**
* \brief This will return the value of an element of the vector
* \param pos is the element of the vector to be returned
* \return the value of the specified element
*/
const PopRatioVector& operator [] (int pos) const { return *v[pos]; };
/**
* \brief This will add new entries to the vector
* \param add is the number of new entries to the vector
* \param length is the number of entries to the PopRatioVector that is created
* \param value is the value that will be entered for the new entries
*/
void AddRows(int add, int length, PopRatio value);
/**
* \brief This will delete an entry from the vector
* \param pos is the element of the vector to be deleted
* \note This will free the memory allocated to the deleted element of the vector
*/
void Delete(int pos);
protected:
/**
* \brief This is number of rows of the vector
*/
int nrow;
/**
* \brief This is the vector of PopRatioVector values
*/
PopRatioVector** v;
};
#endif