Sophie

Sophie

distrib > Fedora > 16 > i386 > by-pkgid > 4bc66056a634db26a1f4d0845dc41ca6 > files > 390

mrpt-doc-0.9.5-0.1.20110925svn2670.fc16.i686.rpm

<!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>CDirectedTree.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> &gt; <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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<div class="header">
  <div class="headertitle">
<div class="title">CDirectedTree.h</div>  </div>
</div>
<div class="contents">
<a href="_c_directed_tree_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  &lt;jlblanco@ctima.uma.es&gt;                     |</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 &lt;http://www.gnu.org/licenses/&gt;.         |</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  MRPT_DIRECTED_TREE_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define  MRPT_DIRECTED_TREE_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="comment">//#include &lt;mrpt/math/utils.h&gt;</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;<a class="code" href="utils__defs_8h.html">mrpt/utils/utils_defs.h</a>&gt;</span>
<a name="l00033"></a>00033 
<a name="l00034"></a>00034 <span class="comment">/*---------------------------------------------------------------</span>
<a name="l00035"></a>00035 <span class="comment">        Class</span>
<a name="l00036"></a>00036 <span class="comment">  ---------------------------------------------------------------*/</span>
<a name="l00037"></a>00037 <span class="keyword">namespace </span>mrpt
<a name="l00038"></a>00038 {
<a name="l00039"></a>00039         <span class="keyword">namespace </span>graphs
<a name="l00040"></a>00040         {
<a name="l00041"></a>00041                 <span class="keyword">using</span> mrpt<a class="code" href="namespacemrpt_1_1utils.html#a718b4f99645b7e9f6501c9b7bb2a2fe7" title="The type for node IDs in graphs of different types.">::utils::TNodeID</a>;
<a name="l00042"></a>00042 <span class="comment"></span>
<a name="l00043"></a>00043 <span class="comment">                /** A special kind of graph in the form of a tree with directed edges and optional edge annotations of templatized type &quot;TYPE_EDGES&quot;.</span>
<a name="l00044"></a>00044 <span class="comment">                  *  The tree is represented by means of:</span>
<a name="l00045"></a>00045 <span class="comment">                  *             - \a root: The ID of the root node.</span>
<a name="l00046"></a>00046 <span class="comment">                  *             - \a edges_to_children: A map from node ID to all the edges to its children.</span>
<a name="l00047"></a>00047 <span class="comment">                  *</span>
<a name="l00048"></a>00048 <span class="comment">                  *  This class is less general than CDirectedGraph but more efficient to traverse (see \a visitDepthFirst and \a visitBreadthFirst).</span>
<a name="l00049"></a>00049 <span class="comment">                  *</span>
<a name="l00050"></a>00050 <span class="comment">                  *  If annotations in edges are not required, you can leave TYPE_EDGES to its default type &quot;uint8_t&quot;.</span>
<a name="l00051"></a>00051 <span class="comment">                  *  \sa CDirectedGraph, CDijkstra, mrpt::graphs::CNetworkOfPoses,</span>
<a name="l00052"></a>00052 <span class="comment">                 * \ingroup mrpt_graphs_grp</span>
<a name="l00053"></a>00053 <span class="comment">                  */</span>
<a name="l00054"></a>00054                 <span class="keyword">template</span> &lt;<span class="keyword">class</span> TYPE_EDGES = u<span class="keywordtype">int</span>8_t&gt;
<a name="l00055"></a>00055                 <span class="keyword">class </span>CDirectedTree
<a name="l00056"></a>00056                 {
<a name="l00057"></a>00057                 <span class="keyword">public</span>:
<a name="l00058"></a>00058                         <span class="keyword">struct </span>TEdgeInfo
<a name="l00059"></a>00059                         {
<a name="l00060"></a><a class="code" href="structmrpt_1_1graphs_1_1_c_directed_tree_1_1_t_edge_info.html#aa37cdfd65d7d14817a8455c6961af4b2">00060</a>                                 <a class="code" href="namespacemrpt_1_1utils.html#a718b4f99645b7e9f6501c9b7bb2a2fe7" title="The type for node IDs in graphs of different types.">TNodeID</a>    <a class="code" href="structmrpt_1_1graphs_1_1_c_directed_tree_1_1_t_edge_info.html#aa37cdfd65d7d14817a8455c6961af4b2" title="The ID of the child node.">id</a>;      <span class="comment">//!&lt; The ID of the child node.</span>
<a name="l00061"></a><a class="code" href="structmrpt_1_1graphs_1_1_c_directed_tree_1_1_t_edge_info.html#a1fc5b4b73f475960f9552dd196badfa7">00061</a> <span class="comment"></span>                                <span class="keywordtype">bool</span>       <a class="code" href="structmrpt_1_1graphs_1_1_c_directed_tree_1_1_t_edge_info.html#a1fc5b4b73f475960f9552dd196badfa7" title="True if edge direction is child-&gt;parent, false if it&#39;s parent-&gt;child.">reverse</a>; <span class="comment">//!&lt; True if edge direction is child-&gt;parent, false if it&#39;s parent-&gt;child.</span>
<a name="l00062"></a><a class="code" href="structmrpt_1_1graphs_1_1_c_directed_tree_1_1_t_edge_info.html#af2ef844b7b638ac84eb778db3da5b77e">00062</a> <span class="comment"></span>                                TYPE_EDGES <a class="code" href="structmrpt_1_1graphs_1_1_c_directed_tree_1_1_t_edge_info.html#af2ef844b7b638ac84eb778db3da5b77e" title="User data for this edge.">data</a>;    <span class="comment">//!&lt; User data for this edge.</span>
<a name="l00063"></a>00063 <span class="comment"></span>                        };
<a name="l00064"></a><a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#a66c4512d71c6610d93f6e5f5341143fd">00064</a>                         <span class="keyword">typedef</span> std<a class="code" href="classstd_1_1list.html" title="STL class.">::list&lt;TEdgeInfo&gt;</a>          <a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#a66c4512d71c6610d93f6e5f5341143fd">TListEdges</a>;
<a name="l00065"></a><a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#aec4dfc04eb7b1a5a42f4e37fb87a85fa">00065</a>                         <span class="keyword">typedef</span> std<a class="code" href="classstd_1_1map.html">::map&lt;TNodeID,TListEdges&gt;</a>  <a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#aec4dfc04eb7b1a5a42f4e37fb87a85fa">TMapNode2ListEdges</a>;
<a name="l00066"></a>00066 <span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment">                        /** @name Data</span>
<a name="l00068"></a>00068 <span class="comment">                            @{ */</span>
<a name="l00069"></a><a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#abe1d11c870b7f6959c3a1ed7e80d09c6">00069</a>                         <a class="code" href="namespacemrpt_1_1utils.html#a718b4f99645b7e9f6501c9b7bb2a2fe7" title="The type for node IDs in graphs of different types.">TNodeID</a>            <a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#abe1d11c870b7f6959c3a1ed7e80d09c6" title="The root of the tree.">root</a>;               <span class="comment">//!&lt; The root of the tree</span>
<a name="l00070"></a><a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#a35deef833923a007dd80797da31854ee">00070</a> <span class="comment"></span>                        <a class="code" href="classstd_1_1map.html">TMapNode2ListEdges</a> <a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#a35deef833923a007dd80797da31854ee" title="The edges of each node.">edges_to_children</a>;  <span class="comment">//!&lt; The edges of each node</span>
<a name="l00071"></a>00071 <span class="comment"></span><span class="comment">                        /** @} */</span>
<a name="l00072"></a>00072 <span class="comment"></span>
<a name="l00073"></a>00073 <span class="comment">                        /** @name Utilities</span>
<a name="l00074"></a>00074 <span class="comment">                            @{ */</span>
<a name="l00075"></a>00075 <span class="comment"></span>
<a name="l00076"></a>00076 <span class="comment">                        /** Empty all edge data and set &quot;root&quot; to INVALID_NODEID */</span>
<a name="l00077"></a><a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#adc8f90b30fd8e07a984fe19b8a360b8c">00077</a>                         <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#adc8f90b30fd8e07a984fe19b8a360b8c" title="Empty all edge data and set &quot;root&quot; to INVALID_NODEID.">clear</a>() { <a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#a35deef833923a007dd80797da31854ee" title="The edges of each node.">edges_to_children</a>.clear(); <a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#abe1d11c870b7f6959c3a1ed7e80d09c6" title="The root of the tree.">root</a> = <a class="code" href="base_2include_2mrpt_2utils_2types_8h.html#adc1f75e937273167bcd0a11caf344fce">INVALID_NODEID</a>; }
<a name="l00078"></a>00078 <span class="comment"></span>
<a name="l00079"></a>00079 <span class="comment">                        /** Virtual base class for user-defined visitors */</span>
<a name="l00080"></a>00080                         <span class="keyword">struct </span>Visitor
<a name="l00081"></a>00081                         {
<a name="l00082"></a><a class="code" href="structmrpt_1_1graphs_1_1_c_directed_tree_1_1_visitor.html#a2e245f6894582ee25f8cf2615b433fb6">00082</a>                                 <span class="keyword">typedef</span> <a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html" title="A special kind of graph in the form of a tree with directed edges and optional edge annotations of te...">CDirectedTree&lt;TYPE_EDGES&gt;</a> <a class="code" href="structmrpt_1_1graphs_1_1_c_directed_tree_1_1_visitor.html#a2e245f6894582ee25f8cf2615b433fb6">tree_t</a>;
<a name="l00083"></a>00083 <span class="comment"></span>
<a name="l00084"></a>00084 <span class="comment">                                /** Virtual method to be implemented by the user and which will be called during the visit to a graph with visitDepthFirst or visitBreadthFirst</span>
<a name="l00085"></a>00085 <span class="comment">                                  *  Specifically, the method will be called once for each &lt;b&gt;edge&lt;/b&gt; in the tree.</span>
<a name="l00086"></a>00086 <span class="comment">                                  * \param parent [IN] The ID of the parent node.</span>
<a name="l00087"></a>00087 <span class="comment">                                  * \param edge_to_child [IN] The edge information from the parent to &quot;edge_to_child.id&quot;</span>
<a name="l00088"></a>00088 <span class="comment">                                  * \param depth_level [IN] The &quot;depth level&quot; of the child node &quot;edge_to_child.id&quot; (root node is at 0, its children are at 1, etc.).</span>
<a name="l00089"></a>00089 <span class="comment">                                  */</span>
<a name="l00090"></a>00090                                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structmrpt_1_1graphs_1_1_c_directed_tree_1_1_visitor.html#acfce764b342a2b6b21361effc7d6f47c" title="Virtual method to be implemented by the user and which will be called during the visit to a graph wit...">OnVisitNode</a>( <span class="keyword">const</span> <a class="code" href="namespacemrpt_1_1utils.html#a718b4f99645b7e9f6501c9b7bb2a2fe7" title="The type for node IDs in graphs of different types.">TNodeID</a> parent, <span class="keyword">const</span> <span class="keyword">typename</span> <a class="code" href="structmrpt_1_1graphs_1_1_c_directed_tree_1_1_t_edge_info.html">tree_t::TEdgeInfo</a> &amp;edge_to_child, <span class="keyword">const</span> <span class="keywordtype">size_t</span> depth_level ) = 0;
<a name="l00091"></a>00091                         };
<a name="l00092"></a>00092 <span class="comment"></span>
<a name="l00093"></a>00093 <span class="comment">                        /** Depth-first visit of all children nodes of a given root (itself excluded from the visit), invoking a user-provided function for each node/edge. \sa visitBreadthFirst */</span>
<a name="l00094"></a><a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#a3c865f7abff4499faaf87f09065d0a5a">00094</a>                         <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#a3c865f7abff4499faaf87f09065d0a5a" title="Depth-first visit of all children nodes of a given root (itself excluded from the visit)...">visitDepthFirst</a>( <span class="keyword">const</span> <a class="code" href="namespacemrpt_1_1utils.html#a718b4f99645b7e9f6501c9b7bb2a2fe7" title="The type for node IDs in graphs of different types.">TNodeID</a> <a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#abe1d11c870b7f6959c3a1ed7e80d09c6" title="The root of the tree.">root</a>, <a class="code" href="structmrpt_1_1graphs_1_1_c_directed_tree_1_1_visitor.html" title="Virtual base class for user-defined visitors.">Visitor</a> &amp; user_visitor, <span class="keyword">const</span> <span class="keywordtype">size_t</span> root_depth_level =0 )<span class="keyword"> const</span>
<a name="l00095"></a>00095 <span class="keyword">                        </span>{
<a name="l00096"></a>00096                                 <span class="keyword">const</span> <span class="keywordtype">size_t</span> next_depth_level = root_depth_level+1;
<a name="l00097"></a>00097                                 <span class="keyword">typename</span> <a class="code" href="classstd_1_1map.html">TMapNode2ListEdges</a><a class="code" href="eigen__plugins_8h.html#a8dbda719917732693c56cee228465ed9">::const_iterator</a> itChildren = <a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#a35deef833923a007dd80797da31854ee" title="The edges of each node.">edges_to_children</a>.find(root);
<a name="l00098"></a>00098                                 <span class="keywordflow">if</span> (itChildren==<a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#a35deef833923a007dd80797da31854ee" title="The edges of each node.">edges_to_children</a>.end()) <span class="keywordflow">return</span>; <span class="comment">// No children</span>
<a name="l00099"></a>00099                                 <span class="keyword">const</span> <a class="code" href="classstd_1_1list.html" title="STL class.">TListEdges</a> &amp;children = itChildren-&gt;second;
<a name="l00100"></a>00100                                 <span class="keywordflow">for</span> (<span class="keyword">typename</span> <a class="code" href="classstd_1_1list_1_1const__iterator.html" title="STL iterator class.">TListEdges::const_iterator</a> itEdge=children.begin();itEdge!=children.end();++itEdge)
<a name="l00101"></a>00101                                 {
<a name="l00102"></a>00102                                         user_visitor.OnVisitNode(root,*itEdge,next_depth_level);
<a name="l00103"></a>00103                                         <a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#a3c865f7abff4499faaf87f09065d0a5a" title="Depth-first visit of all children nodes of a given root (itself excluded from the visit)...">visitDepthFirst</a>(itEdge-&gt;id,user_visitor, next_depth_level); <span class="comment">// Recursive depth-first call.</span>
<a name="l00104"></a>00104                                 }
<a name="l00105"></a>00105                         }
<a name="l00106"></a>00106 <span class="comment"></span>
<a name="l00107"></a>00107 <span class="comment">                        /** Breadth-first visit of all children nodes of a given root (itself excluded from the visit), invoking a user-provided function for each node/edge. \sa visitDepthFirst */</span>
<a name="l00108"></a><a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#ad9ca00ddc3f9f8434c9958829986b00d">00108</a>                         <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#ad9ca00ddc3f9f8434c9958829986b00d" title="Breadth-first visit of all children nodes of a given root (itself excluded from the visit)...">visitBreadthFirst</a>( <span class="keyword">const</span> <a class="code" href="namespacemrpt_1_1utils.html#a718b4f99645b7e9f6501c9b7bb2a2fe7" title="The type for node IDs in graphs of different types.">TNodeID</a> <a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#abe1d11c870b7f6959c3a1ed7e80d09c6" title="The root of the tree.">root</a>, <a class="code" href="structmrpt_1_1graphs_1_1_c_directed_tree_1_1_visitor.html" title="Virtual base class for user-defined visitors.">Visitor</a> &amp; user_visitor, <span class="keyword">const</span> <span class="keywordtype">size_t</span> root_depth_level =0  )<span class="keyword"> const</span>
<a name="l00109"></a>00109 <span class="keyword">                        </span>{
<a name="l00110"></a>00110                                 <span class="keyword">const</span> <span class="keywordtype">size_t</span> next_depth_level = root_depth_level+1;
<a name="l00111"></a>00111                                 <span class="keyword">typename</span> <a class="code" href="classstd_1_1map.html">TMapNode2ListEdges</a><a class="code" href="eigen__plugins_8h.html#a8dbda719917732693c56cee228465ed9">::const_iterator</a> itChildren = <a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#a35deef833923a007dd80797da31854ee" title="The edges of each node.">edges_to_children</a>.find(root);
<a name="l00112"></a>00112                                 <span class="keywordflow">if</span> (itChildren==<a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#a35deef833923a007dd80797da31854ee" title="The edges of each node.">edges_to_children</a>.end()) <span class="keywordflow">return</span>; <span class="comment">// No children</span>
<a name="l00113"></a>00113                                 <span class="keyword">const</span> <a class="code" href="classstd_1_1list.html" title="STL class.">TListEdges</a> &amp;children = itChildren-&gt;second;
<a name="l00114"></a>00114                                 <span class="keywordflow">for</span> (<span class="keyword">typename</span> <a class="code" href="classstd_1_1list_1_1const__iterator.html" title="STL iterator class.">TListEdges::const_iterator</a> itEdge=children.begin();itEdge!=children.end();++itEdge)
<a name="l00115"></a>00115                                         user_visitor.OnVisitNode(root,*itEdge,next_depth_level);
<a name="l00116"></a>00116                                 <span class="keywordflow">for</span> (<span class="keyword">typename</span> <a class="code" href="classstd_1_1list_1_1const__iterator.html" title="STL iterator class.">TListEdges::const_iterator</a> itEdge=children.begin();itEdge!=children.end();++itEdge)
<a name="l00117"></a>00117                                         <a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#a3c865f7abff4499faaf87f09065d0a5a" title="Depth-first visit of all children nodes of a given root (itself excluded from the visit)...">visitDepthFirst</a>(itEdge-&gt;id,user_visitor,next_depth_level); <span class="comment">// Recursive breath-first call.</span>
<a name="l00118"></a>00118                         }
<a name="l00119"></a>00119 <span class="comment"></span>
<a name="l00120"></a>00120 <span class="comment">                        /** Return a text representation of the tree spanned in a depth-first view, as in this example:</span>
<a name="l00121"></a>00121 <span class="comment">                          *  \code</span>
<a name="l00122"></a>00122 <span class="comment">                          *    0</span>
<a name="l00123"></a>00123 <span class="comment">                          *     -&gt; 1</span>
<a name="l00124"></a>00124 <span class="comment">                          *     -&gt; 2</span>
<a name="l00125"></a>00125 <span class="comment">                          *         -&gt; 4</span>
<a name="l00126"></a>00126 <span class="comment">                          *         -&gt; 5</span>
<a name="l00127"></a>00127 <span class="comment">                          *     -&gt; 3</span>
<a name="l00128"></a>00128 <span class="comment">                          *  \endcode</span>
<a name="l00129"></a>00129 <span class="comment">                          */</span>
<a name="l00130"></a><a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#a256e7fc87002b49d6e0b3c6569e1e86c">00130</a>                         std<a class="code" href="classstd_1_1string.html" title="STL class.">::string</a> <a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#a256e7fc87002b49d6e0b3c6569e1e86c" title="Return a text representation of the tree spanned in a depth-first view, as in this example:...">getAsTextDescription</a>()<span class="keyword"> const</span>
<a name="l00131"></a>00131 <span class="keyword">                        </span>{
<a name="l00132"></a>00132                                 std<a class="code" href="classstd_1_1ostringstream.html" title="STL class.">::ostringstream</a> s;
<a name="l00133"></a>00133                                 <span class="keyword">struct </span>CMyVisitor : <span class="keyword">public</span> mrpt::graphs::<a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html" title="A special kind of graph in the form of a tree with directed edges and optional edge annotations of te...">CDirectedTree</a>&lt;TYPE_EDGES&gt;::<a class="code" href="structmrpt_1_1graphs_1_1_c_directed_tree_1_1_visitor.html" title="Virtual base class for user-defined visitors.">Visitor</a>
<a name="l00134"></a>00134                                 {
<a name="l00135"></a>00135                                         std<a class="code" href="classstd_1_1ostringstream.html" title="STL class.">::ostringstream</a>  &amp;m_s;
<a name="l00136"></a>00136                                         CMyVisitor(<a class="code" href="classstd_1_1ostringstream.html" title="STL class.">std::ostringstream</a> &amp;s) : m_s(s) { }
<a name="l00137"></a>00137                                         <span class="keyword">virtual</span> <span class="keywordtype">void</span> OnVisitNode( <span class="keyword">const</span> <a class="code" href="namespacemrpt_1_1utils.html#a718b4f99645b7e9f6501c9b7bb2a2fe7" title="The type for node IDs in graphs of different types.">TNodeID</a> parent, <span class="keyword">const</span> <span class="keyword">typename</span> <a class="code" href="structmrpt_1_1graphs_1_1_c_directed_tree_1_1_t_edge_info.html">mrpt::graphs::CDirectedTree&lt;TYPE_EDGES&gt;::Visitor::tree_t::TEdgeInfo</a> &amp;edge_to_child, <span class="keyword">const</span> <span class="keywordtype">size_t</span> depth_level ) {
<a name="l00138"></a>00138                                                 m_s &lt;&lt; <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a>(depth_level*5, <span class="charliteral">&#39; &#39;</span>) &lt;&lt; (edge_to_child.<a class="code" href="structmrpt_1_1graphs_1_1_c_directed_tree_1_1_t_edge_info.html#a1fc5b4b73f475960f9552dd196badfa7" title="True if edge direction is child-&gt;parent, false if it&#39;s parent-&gt;child.">reverse</a> ? <span class="stringliteral">&quot;&lt;-&quot;</span> : <span class="stringliteral">&quot;-&gt;&quot;</span> ) <span class="comment">//;</span>
<a name="l00139"></a>00139                                                         &lt;&lt; std::setw(3) &lt;&lt; edge_to_child.<a class="code" href="structmrpt_1_1graphs_1_1_c_directed_tree_1_1_t_edge_info.html#aa37cdfd65d7d14817a8455c6961af4b2" title="The ID of the child node.">id</a> &lt;&lt; std::endl;
<a name="l00140"></a>00140                                         }
<a name="l00141"></a>00141                                 };
<a name="l00142"></a>00142                                 CMyVisitor myVisitor(s);
<a name="l00143"></a>00143                                 s &lt;&lt; std::setw(3) &lt;&lt; <a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#abe1d11c870b7f6959c3a1ed7e80d09c6" title="The root of the tree.">root</a> &lt;&lt; std::endl;
<a name="l00144"></a>00144                                 <a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#a3c865f7abff4499faaf87f09065d0a5a" title="Depth-first visit of all children nodes of a given root (itself excluded from the visit)...">visitDepthFirst</a>( <a class="code" href="classmrpt_1_1graphs_1_1_c_directed_tree.html#abe1d11c870b7f6959c3a1ed7e80d09c6" title="The root of the tree.">root</a>, myVisitor );
<a name="l00145"></a>00145                                 <span class="keywordflow">return</span> s.str();
<a name="l00146"></a>00146                         }
<a name="l00147"></a>00147 
<a name="l00148"></a>00148                 };
<a name="l00149"></a>00149 <span class="comment"></span>
<a name="l00150"></a>00150 <span class="comment">                /** @} */</span>
<a name="l00151"></a>00151         } <span class="comment">// End of namespace</span>
<a name="l00152"></a>00152 } <span class="comment">// End of namespace</span>
<a name="l00153"></a>00153 <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>