COIN-OR::LEMON - Graph Library

Changeset 154:eb8dcb4ab78d in lemon-0.x


Ignore:
Timestamp:
03/04/04 16:13:43 (16 years ago)
Author:
marci
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@216
Message:

* empty log message *

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc-docbook/src/xml/search_iterator.xml

    r153 r154  
    11<etik:class>
    22 <etik:name>
    3   Osztaly neve
     3  BfsIterator4<![CDATA[<]]>typename Graph, typename OutEdgeIt,
     4            typename ReachedMap<![CDATA[>]]>
    45 </etik:name>
    56
    67 <etik:description>
     8The class IteratorBfs4 <![CDATA[<]]>typename Graph, typename OutEdgeIt,
     9            typename ReachedMap<![CDATA[>]]> implements an edge iterator which iterates on the edges of a directed or undirected graph in a breadth first search order. As a bare iterator, it stores the actual edge, the bfs queue and the map of reached nodes. The usual interpretation of bfs consists of computing auxiliary quantities i.e. distance from root or tree of edges on which the reachable nodes were reached. This iterator approach entrusts such functionalities to the user, they have to be implemented out of the class.
    710 Ez itt egy tobbsoros, tobb reszes leiras arrol, hogy altalanossagban
    811 mire is jo ez az osztaly.  Ez itt egy tobbsoros, tobb reszes leiras
     
    5154
    5255 <etik:definition>
     56Defined in bfs_iterator.hh.
    5357Ez a definition szekcio arra van, hogy beleirjuk, hogy milyen fajlban
    5458van definialva az aktualis osztaly.
     
    5963<etik:template_param>
    6064<etik:templ_name>
    61 T
     65Graph
    6266</etik:templ_name>
    6367<etik:templ_description>
    64 Ez itt a T parameter. Ebben adod meg hogy milyen izekbol epitsunk kupacot.
     68Graph is a graph type which have to satisfy some concept requirements defined at a later date.
    6569</etik:templ_description>
    6670<etik:templ_requirement>
     71Mittomen
    6772Legyen implementalva neki az osszehasonlito operator.
    6873</etik:templ_requirement>
     
    7378<etik:template_param>
    7479<etik:templ_name>
    75 Af
     80OutEdgeIt
    7681</etik:templ_name>
    7782<etik:templ_description>
     83OutEdgeIt is an edge iterator type.
     84The bfs iterator iterates on the edges.
    7885Az Af template parameter is egy olyan vacak, ami a generikussaghoz kell.
    7986</etik:templ_description>
     
    8592</etik:templ_default>
    8693</etik:template_param>
     94<etik:template_param>
     95<etik:templ_name>
     96ReachedMap
     97</etik:templ_name>
     98<etik:templ_description>
     99ReachedMap is a map type which stores a bool for each node, and will ne used to maintain the set of reached nodes.
     100Az Af template parameter is egy olyan vacak, ami a generikussaghoz kell.
     101</etik:templ_description>
     102<etik:templ_requirement>
     103Readable and Writable nodemap.
     104Af szarmazzon az elemi osztalyokbol.
     105</etik:templ_requirement>
     106<etik:templ_default>
     1070
     108</etik:templ_default>
     109</etik:template_param>
    87110</etik:template_params>
    88111
    89112
    90113<etik:members>
    91 <etik:member>
    92 <etik:m_name>
    93 iterator
    94 </etik:m_name>
    95 <etik:m_where_def>
    96 container
    97 </etik:m_where_def>
    98 <etik:m_description>
    99 Arra valo, hogy vegigiteraljunk vele.
    100 </etik:m_description>
    101 
    102 </etik:member>
    103 <etik:member>
    104 <etik:m_name>
    105 void push_back(const T&)
    106 </etik:m_name>
    107 <etik:m_where_def>
    108 Back Insertion Sequence
    109 </etik:m_where_def>
    110 <etik:m_description>
    111 Egy uj element tesz e vegere.
    112 </etik:m_description>
    113 
    114 </etik:member>
     114
     115<etik:member>
     116<etik:m_name>
     117BfsIterator4(const Graph& _G, ReachedMap& _reached)
     118</etik:m_name>
     119<etik:m_where_def>
     120
     121</etik:m_where_def>
     122<etik:m_description>
     123Creates a bfs iterator with empty queue. The reached nodes will be stores in
     124the map for that _reached refers. Initially, _reached have to be an everywhere
     125false map. Other cases also can be specified, but due to the difficulty, I have no stomach to deal with it.
     126</etik:m_description>
     127
     128</etik:member>
     129
     130<etik:member>
     131<etik:m_name>
     132BfsIterator4(const Graph& _G)
     133</etik:m_name>
     134<etik:m_where_def>
     135-
     136</etik:m_where_def>
     137<etik:m_description>
     138The same as above, but an own map is constructed to store the reached nodes (and is destroyed at the and).
     139</etik:m_description>
     140
     141</etik:member>
     142
     143<etik:member>
     144<etik:m_name>
     145void pushAndSetReached(NodeIt s)
     146</etik:m_name>
     147<etik:m_where_def>
     148
     149</etik:m_where_def>
     150<etik:m_description>
     151Inserts s in the bfs queue and marks it reached.
     152</etik:m_description>
     153
     154</etik:member>
     155
     156<etik:member>
     157<etik:m_name>
     158BfsIterator4<![CDATA[<]]>Graph, OutEdgeIt, ReachedMap<![CDATA[>]]>& operator++()
     159</etik:m_name>
     160<etik:m_where_def>
     161container
     162</etik:m_where_def>
     163<etik:m_description>
     164Executes one step on the bfs iterator.
     165</etik:m_description>
     166
     167</etik:member>
     168
     169<etik:member>
     170<etik:m_name>
     171bool finished() const
     172</etik:m_name>
     173<etik:m_where_def>
     174container
     175</etik:m_where_def>
     176<etik:m_description>
     177Returns true if and only if the iteration is finished.
     178</etik:m_description>
     179
     180</etik:member>
     181
     182<etik:member>
     183<etik:m_name>
     184operator OutEdgeIt () const
     185</etik:m_name>
     186<etik:m_where_def>
     187container
     188</etik:m_where_def>
     189<etik:m_description>
     190This conversion operator returns the actual value of the bfs iterator.
     191</etik:m_description>
     192
     193</etik:member>
     194
     195<etik:member>
     196<etik:m_name>
     197bool isBNodeNewlyReached() const
     198</etik:m_name>
     199<etik:m_where_def>
     200container
     201</etik:m_where_def>
     202<etik:m_description>
     203Precondition: OutEdgeIt() returns a valid iterator.
     204Returns true if and only if bNode of OutEdgeIt() is reached at the last
     205iteration step.
     206</etik:m_description>
     207
     208</etik:member>
     209
     210<etik:member>
     211<etik:m_name>
     212bool isANodeExamined() const
     213</etik:m_name>
     214<etik:m_where_def>
     215container
     216</etik:m_where_def>
     217<etik:m_description>
     218Returns true if and only if the actual node bacomes examined.
     219</etik:m_description>
     220
     221</etik:member>
     222
     223<etik:member>
     224<etik:m_name>
     225NodeIt aNode() const
     226</etik:m_name>
     227<etik:m_where_def>
     228container
     229</etik:m_where_def>
     230<etik:m_description>
     231Returns the actual node.
     232</etik:m_description>
     233
     234</etik:member>
     235
     236<etik:member>
     237<etik:m_name>
     238NodeIt bNode() const
     239</etik:m_name>
     240<etik:m_where_def>
     241container
     242</etik:m_where_def>
     243<etik:m_description>
     244Precondition: OutEdgeIt() returns a valid iterator.
     245Returns bNode of the actual edge..
     246</etik:m_description>
     247
     248</etik:member>
     249
     250<etik:member>
     251<etik:m_name>
     252const ReachedMap& getReachedMap() const
     253</etik:m_name>
     254<etik:m_where_def>
     255container
     256</etik:m_where_def>
     257<etik:m_description>
     258Const reference to the reached map.
     259</etik:m_description>
     260
     261</etik:member>
     262
     263<etik:member>
     264<etik:m_name>
     265const std::queue<![CDATA[<]]>NodeIt<![CDATA[>]]>& getBfsQueue() const
     266</etik:m_name>
     267<etik:m_where_def>
     268container
     269</etik:m_where_def>
     270<etik:m_description>
     271Const reference to the bfs queue.
     272</etik:m_description>
     273
     274</etik:member>
     275
     276
    115277</etik:members>
    116278
Note: See TracChangeset for help on using the changeset viewer.