vcs_IntStarStar.h

Go to the documentation of this file.

/**
 *  @file  vcs_IntStarStar.h  Header file for class IntStarStar
 */
#ifndef VCS_INTSTARSTAR_H
#define VCS_INTSTARSTAR_H

#include <vector>

namespace VCSnonideal
{
using std::size_t;

//!  A class for 2D int arrays stored in column-major
//!  (Fortran-compatible) form.
/*!
 *  In this form, the data entry for an `n` row, `m` colum matrix is index =
 *  `i + (n-1) * j` where `Matrix[j][i]` references the element in row `i`,
 *  column `j`.
 */
class IntStarStar
{
public:
    //! Default constructor. Create an empty array.
    IntStarStar();

    //! Constructor.
    /*!
     *  Create an \c nrow by \c mcol int array, and initialize
     *  all elements to \c v.
     *
     * @param mcol  Number of columns
     * @param nrow  Number of rows
     * @param v     value used to initialize elements
     */
    IntStarStar(size_t mcol, size_t nrow, int v = 0);

    IntStarStar(const IntStarStar& y);
    IntStarStar& operator=(const IntStarStar& y);

    //! Resize the array, and fill the new entries with 'v'
    /*!
     * @param mcol  This is the number of columns in the new matrix
     * @param nrow  This is the number of rows
     * @param v     Default fill value -> defaults to zero.
     */
    void resize(size_t mcol, size_t nrow, int v = 0);

    //! Pointer to the top of the column
    /*!
     *  @param jcol Pointer to the top of the jth column
     */
    int* operator[](size_t jcol);

    //! Pointer to the top of the column
    /*!
     *  @param jcol Pointer to the top of the jth column
     */
    const int* operator[](size_t jcol) const;

    //! Returns a `int**` pointer to the base address
    /*!
     *  This is the second way to get to the data This returns a `int**` which
     *  can later be used in `Imatrix[icol][irow]` notation to get to the data
     */
    int* const* baseDataAddr();

    //! Number of rows
    size_t nRows() const;

    //! Number of columns
    size_t nColumns() const;

private:
    //! Storage area for the matrix, layed out in Fortran style, row-inner,
    //! column outer format
    /*!
     * Length = m_nrows * m_ncols
     */
    std::vector<int> m_data;

    //! Vector of column addresses
    /*!
     * Length = number of columns = m_ncols
     */
    std::vector<int*> m_colAddr;

    //! number of rows
    size_t m_nrows;

    //! number of columns
    size_t m_ncols;
};

}

#endif