source: lemon-0.x/doc-docbook/src/xml/search_iterator.xml @ 276:b38f4cfa76cf

<etik:class>
 <etik:name> 
  BfsIterator4<![CDATA[<]]>typename Graph, typename OutEdgeIt, 
            typename ReachedMap<![CDATA[>]]>
 </etik:name>

 <etik:description>
The class IteratorBfs4 <![CDATA[<]]>typename Graph, typename OutEdgeIt, 
            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. 
 Ez itt egy tobbsoros, tobb reszes leiras arrol, hogy altalanossagban
 mire is jo ez az osztaly.  Ez itt egy tobbsoros, tobb reszes leiras
 arrol, hogy altalanossagban mire is jo ez az osztaly.
<para>
 Ez itt az uj bekezdese a leirasnak, mert elofordulhat, hogy tobb
 bekezdesre erdemes tagolni az iromanyt.
</para>
 </etik:description>

 <etik:example>
  Gyakran hasznos egy peldan bemutatni a mukodest. A kovetkezo egy
  egyszeru kis szemleltetes arra, hogy ezt milyen konnyen es gyorsan
  lehet hasznalni:
<programlisting>

struct eqstr
{
  bool operator()(const char* s1, const char* s2) const
  {
    return strcmp(s1, s2) == 0;
  }
};

void lookup(const map_type& Map, const char* str)
{

}

</programlisting>

Vigyázat, a programlisting mód parsolt, és minden <![CDATA[<]]>-t értelmez!

<etik:code>
<![CDATA[
  int _i=1;
  int _ii=1;
  ListGraph::EdgeMap<int> my_edge_property(G);
  for(EachEdgeIt i=G.first<EachEdgeIt>(); i.valid(); ++i) {
    my_edge_property.set(i, _i);
    _i*=_ii; ++_ii;
  }
]]>
</etik:code>
</etik:example>

 <etik:definition>
Defined in bfs_iterator.hh.
Ez a definition szekcio arra van, hogy beleirjuk, hogy milyen fajlban
van definialva az aktualis osztaly.
Ez <xref linkend="tutorial"/> egy link a tutorialra.
 </etik:definition>

<etik:template_params>
<etik:template_param>
<etik:templ_name>
Graph
</etik:templ_name>
<etik:templ_description>
Graph is a graph type which have to satisfy some concept requirements defined at a later date.
</etik:templ_description>
<etik:templ_requirement>
Mittomen
Legyen implementalva neki az osszehasonlito operator.
</etik:templ_requirement>
<etik:templ_default>
Az nincs
</etik:templ_default>
</etik:template_param>
<etik:template_param>
<etik:templ_name>
OutEdgeIt
</etik:templ_name>
<etik:templ_description>
OutEdgeIt is an edge iterator type. 
The bfs iterator iterates on the edges.
Az Af template parameter is egy olyan vacak, ami a generikussaghoz kell.
</etik:templ_description>
<etik:templ_requirement>
Af szarmazzon az elemi osztalyokbol.
</etik:templ_requirement>
<etik:templ_default>
0
</etik:templ_default>
</etik:template_param>
<etik:template_param>
<etik:templ_name>
ReachedMap
</etik:templ_name>
<etik:templ_description>
ReachedMap is a map type which stores a bool for each node, and will ne used to maintain the set of reached nodes.
Az Af template parameter is egy olyan vacak, ami a generikussaghoz kell.
</etik:templ_description>
<etik:templ_requirement>
Readable and Writable nodemap.
Af szarmazzon az elemi osztalyokbol.
</etik:templ_requirement>
<etik:templ_default>
0
</etik:templ_default>
</etik:template_param>
</etik:template_params>


<etik:members>

<etik:member>
<etik:m_name>
BfsIterator4(const Graph& _G, ReachedMap& _reached)
</etik:m_name>
<etik:m_where_def>

</etik:m_where_def>
<etik:m_description>
Creates a bfs iterator with empty queue. The reached nodes will be stores in 
the map for that _reached refers. Initially, _reached have to be an everywhere 
false map. Other cases also can be specified, but due to the difficulty, I have no stomach to deal with it.
</etik:m_description>

</etik:member>

<etik:member>
<etik:m_name>
BfsIterator4(const Graph& _G)
</etik:m_name>
<etik:m_where_def>
-
</etik:m_where_def>
<etik:m_description>
The same as above, but an own map is constructed to store the reached nodes (and is destroyed at the and). 
</etik:m_description>

</etik:member>

<etik:member>
<etik:m_name>
void pushAndSetReached(NodeIt s) 
</etik:m_name>
<etik:m_where_def>

</etik:m_where_def>
<etik:m_description>
Inserts s in the bfs queue and marks it reached.
</etik:m_description>

</etik:member>

<etik:member>
<etik:m_name>
BfsIterator4<![CDATA[<]]>Graph, OutEdgeIt, ReachedMap<![CDATA[>]]>& operator++()
</etik:m_name>
<etik:m_where_def>
container
</etik:m_where_def>
<etik:m_description>
Executes one step on the bfs iterator.
</etik:m_description>

</etik:member>

<etik:member>
<etik:m_name>
bool finished() const
</etik:m_name>
<etik:m_where_def>
container
</etik:m_where_def>
<etik:m_description>
Returns true if and only if the iteration is finished.
</etik:m_description>

</etik:member>

<etik:member>
<etik:m_name>
operator OutEdgeIt () const
</etik:m_name>
<etik:m_where_def>
container
</etik:m_where_def>
<etik:m_description>
This conversion operator returns the actual value of the bfs iterator.
</etik:m_description>

</etik:member>

<etik:member>
<etik:m_name>
bool isBNodeNewlyReached() const
</etik:m_name>
<etik:m_where_def>
container
</etik:m_where_def>
<etik:m_description>
Precondition: OutEdgeIt() returns a valid iterator.
Returns true if and only if bNode of OutEdgeIt() is reached at the last 
iteration step.
</etik:m_description>

</etik:member>

<etik:member>
<etik:m_name>
bool isANodeExamined() const
</etik:m_name>
<etik:m_where_def>
container
</etik:m_where_def>
<etik:m_description>
Returns true if and only if the actual node bacomes examined.
</etik:m_description>

</etik:member>

<etik:member>
<etik:m_name>
NodeIt aNode() const
</etik:m_name>
<etik:m_where_def>
container
</etik:m_where_def>
<etik:m_description>
Returns the actual node.
</etik:m_description>

</etik:member>

<etik:member>
<etik:m_name>
NodeIt bNode() const
</etik:m_name>
<etik:m_where_def>
container
</etik:m_where_def>
<etik:m_description>
Precondition: OutEdgeIt() returns a valid iterator.
Returns bNode of the actual edge..
</etik:m_description>

</etik:member>

<etik:member>
<etik:m_name>
const ReachedMap& getReachedMap() const
</etik:m_name>
<etik:m_where_def>
container
</etik:m_where_def>
<etik:m_description>
Const reference to the reached map.
</etik:m_description>

</etik:member>

<etik:member>
<etik:m_name>
const std::queue<![CDATA[<]]>NodeIt<![CDATA[>]]>& getBfsQueue() const
</etik:m_name>
<etik:m_where_def>
container
</etik:m_where_def>
<etik:m_description>
Const reference to the bfs queue.
</etik:m_description>

</etik:member>


</etik:members>




</etik:class>


<!-- Keep this comment at the end of the file
Local variables:
mode: xml
sgml-omittag:nil
sgml-shorttag:nil
sgml-namecase-general:nil
sgml-general-insert-case:lower
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:nil
sgml-parent-document:("graph-classes.xml" "sect1" "etik:class")
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->