CMatrixTemplateObjects.h

Go to the documentation of this file.

/* +------------------------------------------------------------------------+
   |                     Mobile Robot Programming Toolkit (MRPT)            |
   |                          http://www.mrpt.org/                          |
   |                                                                        |
   | Copyright (c) 2005-2018, Individual contributors, see AUTHORS file     |
   | See: http://www.mrpt.org/Authors - All rights reserved.                |
   | Released under BSD License. See details in http://www.mrpt.org/License |
   +------------------------------------------------------------------------+ */
#ifndef CMatrixTemplateObjects_H
#define CMatrixTemplateObjects_H

#include <mrpt/math/CMatrixTemplate.h>

namespace mrpt::math
{
/**  This template class extends the class "CMatrixTemplate" for storing
 *"objects" at each matrix entry.
 *    This class allows a very efficient representation of sparse matrixes where
 *each cell is an arbitrary C++ class,
 *    but its use must carefully observe the following rules:
 *          - The type in the template especialization MUST be a class with a
 *proper
 *default constructor.
 *          - Initially all entries are set to nullptr.
 *          - Pointers can be manually asigned, or automatically created through
 *a
 *call to "CMatrixTemplateObjects<T>::allocAllObjects"
 *          - Independently of how pointers are asigned, memory will be free by
 *destroying objects for each non-NULL entry in the matrix. In some special
 *situations, the user can indicate not to free those objects by calling
 *"CMatrixTemplateObjects<T>::setDestroyBehavior", then it is up to the user to
 *free the memory. In all cases the default behavior is to free the memory.
 *          - Asignament operator with matrixes will COPY THE POINTERS, thus a
 *copy
 *of objects is not performed.
 *          - WARNING: Objects are not deleted while shrinking the matrix by
 *calling
 *"setSize", thus please call ""CMatrixTemplateObjects<T>::freeAllObjects" or
 *manually delete objects before shrinking.
 *
 * \ingroup mrpt_math_grp
 * \sa CMatrixTemplate
 */
template <class T>
class CMatrixTemplateObjects : public CMatrixTemplate<T*>
{
   private:
    bool m_freeObjects;

   public:
    /** Copy constructor
    */
    CMatrixTemplateObjects(const CMatrixTemplate<T>& m)
        : CMatrixTemplate<T*>(m), m_freeObjects(true)
    {
    }

    /** Constructor
    */
    CMatrixTemplateObjects(size_t row = 3, size_t col = 3)
        : CMatrixTemplate<T*>(row, col), m_freeObjects(true)
    {
        for (size_t i = 0; i < CMatrixTemplate<T*>::rows(); i++)
            for (size_t j = 0; j < CMatrixTemplate<T*>::cols(); j++)
                CMatrixTemplate<T*>::m_Val[i][j] = nullptr;
    }

    /** Changes the size of matrix
    */
    virtual void setSize(size_t row, size_t col)
    {
        // TODO: BUGFIX. Doesn't remove objetcs if row<m_Row or col<m_Col
        CMatrixTemplate<T*>::realloc(row, col, true);
    }

    /** Destructor
      */
    virtual ~CMatrixTemplateObjects()
    {
        if (m_freeObjects) freeAllObjects();
    }

    /** Delete all the objects in the matrix and set all entries to nullptr.
      */
    void freeAllObjects()
    {
        for (size_t i = 0; i < CMatrixTemplate<T*>::rows(); i++)
            for (size_t j = 0; j < CMatrixTemplate<T*>::cols(); j++)
                if (CMatrixTemplate<T*>::m_Val[i][j] != nullptr)
                {
                    delete CMatrixTemplate<T*>::m_Val[i][j];
                    CMatrixTemplate<T*>::m_Val[i][j] = nullptr;
                }
    }

    /** Assignment operator
    */
    CMatrixTemplateObjects& operator=(const CMatrixTemplateObjects& m)
    {
        CMatrixTemplate<T*>::realloc(m.rows(), m.cols());

        for (size_t i = 0; i < CMatrixTemplate<T*>::rows(); i++)
            for (size_t j = 0; j < CMatrixTemplate<T*>::cols(); j++)
                CMatrixTemplate<T*>::m_Val[i][j] = m.m_Val[i][j];
        return *this;
    }

    /** Sets the behavior on matrix destroy.
      * See the general description of the class on the top.
      */
    void setDestroyBehavior(bool freeObjects = true)
    {
        m_freeObjects = freeObjects;
    }

    /** Alloc memory for all the non-NULL entries in the matrix.
      * See the general description of the class on the top.
      */
    void allocAllObjects()
    {
        for (size_t i = 0; i < CMatrixTemplate<T*>::rows(); i++)
            for (size_t j = 0; j < CMatrixTemplate<T*>::cols(); j++)
                if (nullptr == CMatrixTemplate<T*>::m_Val[i][j])
                    CMatrixTemplate<T*>::m_Val[i][j] = new T();
    }

};  // end of class definition

}
#endif