Changeset 154:eb8dcb4ab78d in lemon-0.x for doc-docbook/src/xml/search_iterator.xml

Timestamp:

03/04/04 16:13:43 (20 years ago)

Author:

marci

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@216

Message:

* empty log message *

File:

• doc-docbook/src/xml/search_iterator.xml (modified) (5 diffs)

doc-docbook/src/xml/search_iterator.xml

@@ -1 +1 @@
 <etik:class>
  <etik:name> 
-  Osztaly neve
+  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
@@ -51 +54 @@
 
  <etik:definition>
+Defined in bfs_iterator.hh.
 Ez a definition szekcio arra van, hogy beleirjuk, hogy milyen fajlban
 van definialva az aktualis osztaly.
@@ -59 +63 @@
 <etik:template_param>
 <etik:templ_name>
-T
+Graph
 </etik:templ_name>
 <etik:templ_description>
-Ez itt a T parameter. Ebben adod meg hogy milyen izekbol epitsunk kupacot.
+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>
@@ -73 +78 @@
 <etik:template_param>
 <etik:templ_name>
-Af
+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>
@@ -85 +92 @@
 </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>
-iterator
-</etik:m_name>
-<etik:m_where_def>
-container
-</etik:m_where_def>
-<etik:m_description>
-Arra valo, hogy vegigiteraljunk vele.
-</etik:m_description>
-
-</etik:member>
-<etik:member>
-<etik:m_name>
-void push_back(const T&)
-</etik:m_name>
-<etik:m_where_def>
-Back Insertion Sequence
-</etik:m_where_def>
-<etik:m_description>
-Egy uj element tesz e vegere.
-</etik:m_description>
-
-</etik:member>
+
+<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>