<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>CMatrixTemplateObjects.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<div class="left">
<form id="FSearchBox" action="search.php" method="get">
<img id="MSearchSelect" src="search/mag.png" alt=""/>
<input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"/>
</form>
</div><div class="right"></div>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">CMatrixTemplateObjects.h</div> </div>
</div>
<div class="contents">
<a href="_c_matrix_template_objects_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* +---------------------------------------------------------------------------+</span>
<a name="l00002"></a>00002 <span class="comment"> | The Mobile Robot Programming Toolkit (MRPT) C++ library |</span>
<a name="l00003"></a>00003 <span class="comment"> | |</span>
<a name="l00004"></a>00004 <span class="comment"> | http://www.mrpt.org/ |</span>
<a name="l00005"></a>00005 <span class="comment"> | |</span>
<a name="l00006"></a>00006 <span class="comment"> | Copyright (C) 2005-2011 University of Malaga |</span>
<a name="l00007"></a>00007 <span class="comment"> | |</span>
<a name="l00008"></a>00008 <span class="comment"> | This software was written by the Machine Perception and Intelligent |</span>
<a name="l00009"></a>00009 <span class="comment"> | Robotics Lab, University of Malaga (Spain). |</span>
<a name="l00010"></a>00010 <span class="comment"> | Contact: Jose-Luis Blanco <jlblanco@ctima.uma.es> |</span>
<a name="l00011"></a>00011 <span class="comment"> | |</span>
<a name="l00012"></a>00012 <span class="comment"> | This file is part of the MRPT project. |</span>
<a name="l00013"></a>00013 <span class="comment"> | |</span>
<a name="l00014"></a>00014 <span class="comment"> | MRPT is free software: you can redistribute it and/or modify |</span>
<a name="l00015"></a>00015 <span class="comment"> | it under the terms of the GNU General Public License as published by |</span>
<a name="l00016"></a>00016 <span class="comment"> | the Free Software Foundation, either version 3 of the License, or |</span>
<a name="l00017"></a>00017 <span class="comment"> | (at your option) any later version. |</span>
<a name="l00018"></a>00018 <span class="comment"> | |</span>
<a name="l00019"></a>00019 <span class="comment"> | MRPT is distributed in the hope that it will be useful, |</span>
<a name="l00020"></a>00020 <span class="comment"> | but WITHOUT ANY WARRANTY; without even the implied warranty of |</span>
<a name="l00021"></a>00021 <span class="comment"> | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |</span>
<a name="l00022"></a>00022 <span class="comment"> | GNU General Public License for more details. |</span>
<a name="l00023"></a>00023 <span class="comment"> | |</span>
<a name="l00024"></a>00024 <span class="comment"> | You should have received a copy of the GNU General Public License |</span>
<a name="l00025"></a>00025 <span class="comment"> | along with MRPT. If not, see <http://www.gnu.org/licenses/>. |</span>
<a name="l00026"></a>00026 <span class="comment"> | |</span>
<a name="l00027"></a>00027 <span class="comment"> +---------------------------------------------------------------------------+ */</span>
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef CMatrixTemplateObjects_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define CMatrixTemplateObjects_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <<a class="code" href="_c_matrix_template_8h.html">mrpt/math/CMatrixTemplate.h</a>></span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">namespace </span>mrpt
<a name="l00034"></a>00034 {
<a name="l00035"></a>00035 <span class="keyword">namespace </span>math
<a name="l00036"></a>00036 {<span class="comment"></span>
<a name="l00037"></a>00037 <span class="comment">/** This template class extends the class "CMatrixTemplate" for storing "objects" at each matrix entry.</span>
<a name="l00038"></a>00038 <span class="comment"> * This class allows a very efficient representation of sparse matrixes where each cell is an arbitrary C++ class, </span>
<a name="l00039"></a>00039 <span class="comment"> * but its use must carefully observe the following rules:</span>
<a name="l00040"></a>00040 <span class="comment"> * - The type in the template especialization MUST be a class with a proper default constructor.</span>
<a name="l00041"></a>00041 <span class="comment"> * - Initially all entries are set to NULL pointers.</span>
<a name="l00042"></a>00042 <span class="comment"> * - Pointers can be manually asigned, or automatically created through a call to "CMatrixTemplateObjects<T>::allocAllObjects"</span>
<a name="l00043"></a>00043 <span class="comment"> * - 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.</span>
<a name="l00044"></a>00044 <span class="comment"> * - Asignament operator with matrixes will COPY THE POINTERS, thus a copy of objects is not performed.</span>
<a name="l00045"></a>00045 <span class="comment"> * - WARNING: Objects are not deleted while shrinking the matrix by calling "setSize", thus please call ""CMatrixTemplateObjects<T>::freeAllObjects" or manually delete objects before shrinking.</span>
<a name="l00046"></a>00046 <span class="comment"> *</span>
<a name="l00047"></a>00047 <span class="comment"> * \ingroup mrpt_base_grp</span>
<a name="l00048"></a>00048 <span class="comment"> * \sa CMatrixTemplate</span>
<a name="l00049"></a>00049 <span class="comment"> */</span>
<a name="l00050"></a>00050 <span class="keyword">template</span> <<span class="keyword">class</span> T>
<a name="l00051"></a>00051 <span class="keyword">class </span>CMatrixTemplateObjects : <span class="keyword">public</span> CMatrixTemplate<T*>
<a name="l00052"></a>00052 {
<a name="l00053"></a>00053 <span class="keyword">private</span>:
<a name="l00054"></a><a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#af33d4790eec44a27d9d76a9d1e048816">00054</a> <span class="keywordtype">bool</span> <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#af33d4790eec44a27d9d76a9d1e048816">m_freeObjects</a>;
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00057"></a>00057 <span class="comment"> /** Copy constructor</span>
<a name="l00058"></a>00058 <span class="comment"> */</span>
<a name="l00059"></a><a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#a8a2bd256f83905b03aa61027427c8d1c">00059</a> <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#a8a2bd256f83905b03aa61027427c8d1c" title="Copy constructor.">CMatrixTemplateObjects</a>(<span class="keyword">const</span> <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template.html" title="This template class provides the basic functionality for a general 2D any-size, resizable container o...">CMatrixTemplate<T></a>& m) : <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template.html" title="This template class provides the basic functionality for a general 2D any-size, resizable container o...">CMatrixTemplate</a><T*>( m ), <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#af33d4790eec44a27d9d76a9d1e048816">m_freeObjects</a>(true)
<a name="l00060"></a>00060 {
<a name="l00061"></a>00061 }
<a name="l00062"></a>00062 <span class="comment"></span>
<a name="l00063"></a>00063 <span class="comment"> /** Constructor</span>
<a name="l00064"></a>00064 <span class="comment"> */</span>
<a name="l00065"></a><a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#a7c4eddff787a9299ce7d0178fcb72acd">00065</a> <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#a8a2bd256f83905b03aa61027427c8d1c" title="Copy constructor.">CMatrixTemplateObjects</a>(<span class="keywordtype">size_t</span> row = 3, <span class="keywordtype">size_t</span> col = 3) : <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template.html" title="This template class provides the basic functionality for a general 2D any-size, resizable container o...">CMatrixTemplate</a><T*>( row, col ), <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#af33d4790eec44a27d9d76a9d1e048816">m_freeObjects</a>(true)
<a name="l00066"></a>00066 {
<a name="l00067"></a>00067 <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i=0; <a class="code" href="eigen__plugins_8h.html#a61275d6dcd40b0676f9a430be46ef876" title="Get number of rows.">i < CMatrixTemplate<T*>::getRowCount</a>(); i++)
<a name="l00068"></a>00068 <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> j=0; <a class="code" href="eigen__plugins_8h.html#a4d49034b9785c1bd62e4d4540a39066b" title="Get number of columns.">j < CMatrixTemplate<T*>::getColCount</a>(); j++)
<a name="l00069"></a>00069 <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template.html" title="This template class provides the basic functionality for a general 2D any-size, resizable container o...">CMatrixTemplate<T*>::m_Val</a>[i][j] = NULL;
<a name="l00070"></a>00070 }
<a name="l00071"></a>00071 <span class="comment"></span>
<a name="l00072"></a>00072 <span class="comment"> /** Changes the size of matrix</span>
<a name="l00073"></a>00073 <span class="comment"> */</span>
<a name="l00074"></a><a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#a9761820371f23027aa0a1ba502a09e03">00074</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#a9761820371f23027aa0a1ba502a09e03" title="Changes the size of matrix.">setSize</a>(<span class="keywordtype">size_t</span> row, <span class="keywordtype">size_t</span> col)
<a name="l00075"></a>00075 {
<a name="l00076"></a>00076 <span class="comment">//TODO: BUGFIX. Doesn't remove objetcs if row<m_Row or col<m_Col</span>
<a name="l00077"></a>00077 <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template.html#ac10c5fd22bc63a60fd50cdcee3c10835" title="Internal use only: It reallocs the memory for the 2D matrix, maintaining the previous contents if pos...">CMatrixTemplate<T*>::realloc</a>(row,col,<span class="keyword">true</span>);
<a name="l00078"></a>00078 }
<a name="l00079"></a>00079 <span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment"> /** Destructor</span>
<a name="l00081"></a>00081 <span class="comment"> */</span>
<a name="l00082"></a><a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#ad5f4b8e48cb8c21ae60b38dc21c38231">00082</a> <span class="keyword">virtual</span> <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#ad5f4b8e48cb8c21ae60b38dc21c38231" title="Destructor.">~CMatrixTemplateObjects</a>()
<a name="l00083"></a>00083 {
<a name="l00084"></a>00084 <span class="keywordflow">if</span> (<a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#af33d4790eec44a27d9d76a9d1e048816">m_freeObjects</a>)
<a name="l00085"></a>00085 <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#a3b54e039cb173a134dd27c405be4341b" title="Delete all the objects in the matrix and set all entries to NULL pointers.">freeAllObjects</a>();
<a name="l00086"></a>00086 }
<a name="l00087"></a>00087 <span class="comment"></span>
<a name="l00088"></a>00088 <span class="comment"> /** Delete all the objects in the matrix and set all entries to NULL pointers.</span>
<a name="l00089"></a>00089 <span class="comment"> */</span>
<a name="l00090"></a><a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#a3b54e039cb173a134dd27c405be4341b">00090</a> <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#a3b54e039cb173a134dd27c405be4341b" title="Delete all the objects in the matrix and set all entries to NULL pointers.">freeAllObjects</a>()
<a name="l00091"></a>00091 {
<a name="l00092"></a>00092 <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i=0; <a class="code" href="eigen__plugins_8h.html#a61275d6dcd40b0676f9a430be46ef876" title="Get number of rows.">i < CMatrixTemplate<T*>::getRowCount</a>(); i++)
<a name="l00093"></a>00093 <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> j=0; <a class="code" href="eigen__plugins_8h.html#a4d49034b9785c1bd62e4d4540a39066b" title="Get number of columns.">j < CMatrixTemplate<T*>::getColCount</a>(); j++)
<a name="l00094"></a>00094 <span class="keywordflow">if</span> (<a class="code" href="classmrpt_1_1math_1_1_c_matrix_template.html" title="This template class provides the basic functionality for a general 2D any-size, resizable container o...">CMatrixTemplate<T*>::m_Val</a>[i][j]!=NULL)
<a name="l00095"></a>00095 {
<a name="l00096"></a>00096 <span class="keyword">delete</span> <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template.html" title="This template class provides the basic functionality for a general 2D any-size, resizable container o...">CMatrixTemplate<T*>::m_Val</a>[i][j];
<a name="l00097"></a>00097 <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template.html" title="This template class provides the basic functionality for a general 2D any-size, resizable container o...">CMatrixTemplate<T*>::m_Val</a>[i][j] = NULL;
<a name="l00098"></a>00098 }
<a name="l00099"></a>00099 }
<a name="l00100"></a>00100 <span class="comment"></span>
<a name="l00101"></a>00101 <span class="comment"> /** Assignment operator</span>
<a name="l00102"></a>00102 <span class="comment"> */</span>
<a name="l00103"></a><a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#acb97b62bbdabddbebe4c8f19ac8dacdf">00103</a> <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html" title="This template class extends the class "CMatrixTemplate" for storing "objects" at each matrix entry...">CMatrixTemplateObjects</a>& <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#acb97b62bbdabddbebe4c8f19ac8dacdf" title="Assignment operator.">operator = </a>(<span class="keyword">const</span> <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html" title="This template class extends the class "CMatrixTemplate" for storing "objects" at each matrix entry...">CMatrixTemplateObjects</a>& m)
<a name="l00104"></a>00104 {
<a name="l00105"></a>00105 <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template.html#ac10c5fd22bc63a60fd50cdcee3c10835" title="Internal use only: It reallocs the memory for the 2D matrix, maintaining the previous contents if pos...">CMatrixTemplate<T*>::realloc</a>( m.getRowCount(), m.getColCount() );
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i=0; <a class="code" href="eigen__plugins_8h.html#a61275d6dcd40b0676f9a430be46ef876" title="Get number of rows.">i < CMatrixTemplate<T*>::getRowCount</a>(); i++)
<a name="l00108"></a>00108 <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> j=0; <a class="code" href="eigen__plugins_8h.html#a4d49034b9785c1bd62e4d4540a39066b" title="Get number of columns.">j < CMatrixTemplate<T*>::getColCount</a>(); j++)
<a name="l00109"></a>00109 <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template.html" title="This template class provides the basic functionality for a general 2D any-size, resizable container o...">CMatrixTemplate<T*>::m_Val</a>[i][j] = m.m_Val[i][j];
<a name="l00110"></a>00110 <span class="keywordflow">return</span> *<span class="keyword">this</span>;
<a name="l00111"></a>00111 }
<a name="l00112"></a>00112 <span class="comment"></span>
<a name="l00113"></a>00113 <span class="comment"> /** Sets the behavior on matrix destroy.</span>
<a name="l00114"></a>00114 <span class="comment"> * See the general description of the class on the top.</span>
<a name="l00115"></a>00115 <span class="comment"> */</span>
<a name="l00116"></a><a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#aef3385c06a6d102b3d626ef6243b7ea6">00116</a> <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#aef3385c06a6d102b3d626ef6243b7ea6" title="Sets the behavior on matrix destroy.">setDestroyBehavior</a>(<span class="keywordtype">bool</span> freeObjects = <span class="keyword">true</span>)
<a name="l00117"></a>00117 {
<a name="l00118"></a>00118 <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#af33d4790eec44a27d9d76a9d1e048816">m_freeObjects</a> = freeObjects;
<a name="l00119"></a>00119 }
<a name="l00120"></a>00120 <span class="comment"></span>
<a name="l00121"></a>00121 <span class="comment"> /** Alloc memory for all the non-NULL entries in the matrix.</span>
<a name="l00122"></a>00122 <span class="comment"> * See the general description of the class on the top.</span>
<a name="l00123"></a>00123 <span class="comment"> */</span>
<a name="l00124"></a><a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#a2c00270fda68793397786bd4e135c688">00124</a> <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template_objects.html#a2c00270fda68793397786bd4e135c688" title="Alloc memory for all the non-NULL entries in the matrix.">allocAllObjects</a>()
<a name="l00125"></a>00125 {
<a name="l00126"></a>00126 <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i=0; <a class="code" href="eigen__plugins_8h.html#a61275d6dcd40b0676f9a430be46ef876" title="Get number of rows.">i < CMatrixTemplate<T*>::getRowCount</a>(); i++)
<a name="l00127"></a>00127 <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> j=0; <a class="code" href="eigen__plugins_8h.html#a4d49034b9785c1bd62e4d4540a39066b" title="Get number of columns.">j < CMatrixTemplate<T*>::getColCount</a>(); j++)
<a name="l00128"></a>00128 <span class="keywordflow">if</span> (NULL==<a class="code" href="classmrpt_1_1math_1_1_c_matrix_template.html" title="This template class provides the basic functionality for a general 2D any-size, resizable container o...">CMatrixTemplate<T*>::m_Val</a>[i][j])
<a name="l00129"></a>00129 <a class="code" href="classmrpt_1_1math_1_1_c_matrix_template.html" title="This template class provides the basic functionality for a general 2D any-size, resizable container o...">CMatrixTemplate<T*>::m_Val</a>[i][j] = <span class="keyword">new</span> T();
<a name="l00130"></a>00130 }
<a name="l00131"></a>00131
<a name="l00132"></a>00132 }; <span class="comment">// end of class definition</span>
<a name="l00133"></a>00133
<a name="l00134"></a>00134
<a name="l00135"></a>00135 } <span class="comment">// End of namespace</span>
<a name="l00136"></a>00136 } <span class="comment">// End of namespace</span>
<a name="l00137"></a>00137
<a name="l00138"></a>00138 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
