Changeset 203:fc4699a76a6f in lemon0.x
 Timestamp:
 03/19/04 08:40:00 (17 years ago)
 Branch:
 default
 Phase:
 public
 Convert:
 svn:c9d7d8f590d60310b91f818b3a526b0e/lemon/trunk@291
 Location:
 doc
 Files:

 2 edited
Legend:
 Unmodified
 Added
 Removed

doc/Doxyfile
r186 r203 61 61 ../src/doxy/invalid.h \ 62 62 ../src/demo/alpar/smart_graph.h \ 63 ../src/demo/alpar/mapskeleton.h 63 ../src/demo/alpar/mapskeleton.h \ 64 maps.dox 64 65 FILE_PATTERNS = 65 66 RECURSIVE = NO 
doc/flfgraph.texi
r70 r203 22 22 @subsection Types 23 23 24 @ deftp {Type} Graph::NodeType25 @ deftpx {Type} Graph::EdgeType26 The type of the data stored statically for each node and edge.27 @ end deftp24 @c @deftp {Type} Graph::NodeType 25 @c @deftpx {Type} Graph::EdgeType 26 @c The type of the data stored statically for each node and edge. 27 @c @end deftp 28 28 29 29 @anchor{GraphNodeIterator} 30 30 @deftp {Type} Graph::NodeIt 31 @ deftpx {Type} Graph::NodeIterator31 @c @deftpx {Type} Graph::NodeIterator 32 32 These types points a node uniquely. The difference between the 33 33 @code{NodeIt} and the @code{NodeIterator} is that @code{NodeIt} … … 59 59 @deftpx {Type} Graph::InEdgeIt 60 60 @deftpx {Type} Graph::OutEdgeIt 61 @deftpx {Type} Graph::BiEdgeIt 62 @deftpx {Type} Graph::SymEdgeIt 61 @deftpx {Type} Graph::EachEdgeIt 62 @c @deftpx {Type} Graph::BiEdgeIt 63 @c @deftpx {Type} Graph::SymEdgeIt 63 64 Each of these types points an edge uniquely. The difference between the 64 65 @code{EdgeIt} and the … … 71 72 72 73 @anchor{GraphEdgeIterator} 73 @ deftp {Type} Graph::EdgeIterator74 @ deftpx {Type} Graph::InEdgeIterator75 @ deftpx {Type} Graph::OutEdgeIterator76 @ deftpx {Type} Graph::BiEdgeIterator77 @ deftpx {Type} Graph::SymEdgeIterator78 @ deftpx {Type} Graph::EachEdgeIterator79 Each of these types points an edge uniquely. The difference between the80 @c ode{EdgeIt} and the @code{EdgeIterator} series is that81 @c ode{EdgeIt} requires the graph structure itself for most of the82 operations.83 84 For the @code{EdgeIterator} types you can use operator @code{++}85 (both the prefix and the posfix one) to obtain the next edge.86 @ end deftp87 88 @deftp {Type} Graph::NodeMap 89 @deftpx {Type} Graph::EdgeMap 74 @c @deftp {Type} Graph::EdgeIterator 75 @c @deftpx {Type} Graph::InEdgeIterator 76 @c @deftpx {Type} Graph::OutEdgeIterator 77 @c @deftpx {Type} Graph::BiEdgeIterator 78 @c @deftpx {Type} Graph::SymEdgeIterator 79 @c @deftpx {Type} Graph::EachEdgeIterator 80 @c Each of these types points an edge uniquely. The difference between the 81 @c @code{EdgeIt} and the @code{EdgeIterator} series is that 82 @c @code{EdgeIt} requires the graph structure itself for most of the 83 @c operations. 84 85 @c For the @code{EdgeIterator} types you can use operator @code{++} 86 @c (both the prefix and the posfix one) to obtain the next edge. 87 @c @end deftp 88 89 @deftp {Type} Graph::NodeMap<typename T> 90 @deftpx {Type} Graph::EdgeMap<typename T> 90 91 There are the default property maps for the edges and the nodes. 91 92 @end deftp 92 93 94 @deftp {Type} Graph::DynNodeMap<typename T> 95 @deftpx {Type} Graph::DynEdgeMap<typename T> 96 There are the default @emph{dynamic} property maps for the edges and the nodes. 97 @end deftp 93 98 94 99 @subsection Member Functions 95 100 96 101 @subsubsection Constructors 97 98 102 99 103 @deftypefun { } Graph::Graph () … … 103 107 @c @deftypefun { } Graph::Graph (Graph@tie{}&) 104 108 @deftypefun { } Graph::Graph (Graph &) 105 The copy constructor. Not yet implemented.109 The copy constructor. 106 110 @end deftypefun 107 111 108 112 @subsubsection Graph Maintenence Operations 109 113 110 @deftypefun NodeIt eratorGraph::addNode ()111 Adds a new node to the graph and returns a @code{NodeIt erator} pointing to it.112 @end deftypefun 113 114 @deftypefun EdgeIt erator Graph::addEdge (@w{const @mref{GraphNodeIterator,NodeIterator} @var{from}}, @w{const @mref{GraphNodeIterator,NodeIterator} @var{to}})114 @deftypefun NodeIt Graph::addNode () 115 Adds a new node to the graph and returns a @code{NodeIt} pointing to it. 116 @end deftypefun 117 118 @deftypefun EdgeIt Graph::addEdge (@w{const @mref{GraphNodeIterator,NodeIt} @var{from}}, @w{const @mref{GraphNodeIterator,NodeIt} @var{to}}) 115 119 Adds a new edge with tail @var{from} and head @var{to} to the graph 116 and returns an @code{EdgeIt erator} pointing to it.117 @end deftypefun 118 119 @deftypefun void Graph::delete (@w{const @mref{GraphNodeIterator,NodeIt erator} @var{n}})120 and returns an @code{EdgeIt} pointing to it. 121 @end deftypefun 122 123 @deftypefun void Graph::delete (@w{const @mref{GraphNodeIterator,NodeIt} @var{n}}) 120 124 Deletes the node @var{n}. It also deletes the adjacent edges. 121 125 @end deftypefun 122 126 123 @deftypefun void Graph::delete (@w{const @mref{GraphEdgeIterator,EdgeIt erator} @var{e}})127 @deftypefun void Graph::delete (@w{const @mref{GraphEdgeIterator,EdgeIt} @var{e}}) 124 128 Deletes the edge @var{n}. 125 129 @end deftypefun 126 130 127 @deftypefun void Graph::clea n()131 @deftypefun void Graph::clear () 128 132 Deletes all edges and nodes from the graph. 129 133 @end deftypefun … … 131 135 @deftypefun int Graph::nodeNum () 132 136 Returns the number of the nodes in the graph. 137 ??? Is it necessary??? 133 138 @end deftypefun 134 139 135 140 @subsubsection NodeIt Operations 136 141 137 @deftypefun NodeIt Graph::getFirst (NodeIt &@var{n}) 138 @deftypefunx NodeIt Graph:: next (const NodeIt @var{n})139 @deftypefunx {NodeIt &} Graph:: goNext (NodeIt &@var{n})140 The nodes in the graph forms a list. @code{ GetFirst(n)} sets @var{n} to141 be the first node. @code{ next(n)} gives back the subsequent142 node. @code{ Next(n)} is equivalent to @code{n=Next(n)}, though it142 @deftypefun NodeIt Graph::getFirst (NodeIt &@var{n}) const 143 @deftypefunx NodeIt Graph::getNext (NodeIt @var{n}) const 144 @deftypefunx {NodeIt &} Graph::next (NodeIt &@var{n}) 145 The nodes in the graph forms a list. @code{getFirst(n)} sets @var{n} to 146 be the first node. @code{getNext(n)} gives back the subsequent 147 node. @code{next(n)} is equivalent to @code{n=getNext(n)}, though it 143 148 might be faster. ??? What should be the return value ??? 144 149 @end deftypefun 145 150 146 151 @deftypefun bool Graph::valid (NodeIt &@var{e}) 147 @ deftypefunx bool NodeIt::valid ()152 @c @deftypefunx bool NodeIt::valid () 148 153 These functions check if and NodeIt is valid or not. 149 ??? Which one should be implemented ???154 @c ??? Which one should be implemented ??? 150 155 @end deftypefun 151 156 152 157 @subsubsection EdgeIt Operations 153 158 154 @deftypefun EachEdgeIt Graph::getFirst (const EachEdgeIt & @var{e}) 155 @deftypefunx EachEdgeIt Graph:: next (const EachEdgeIt @var{n})156 @deftypefunx {EachEdgeIt &} Graph:: goNext (EachEdgeIt &@var{n})159 @deftypefun EachEdgeIt Graph::getFirst (const EachEdgeIt & @var{e}) const 160 @deftypefunx EachEdgeIt Graph::getNext (EachEdgeIt @var{n}) const 161 @deftypefunx {EachEdgeIt &} Graph::next (EachEdgeIt &@var{n}) 157 162 With these functions you can go though all the edges of the graph. 158 ??? What should be the return value ??? 159 @end deftypefun 160 161 @deftypefun InEdgeIt Graph::getFirst (const InEdgeIt & @var{e}, const NodeIt @var{n}) 162 @deftypefunx OutEdgeIt Graph::getFirst (const OutEdgeIt & @var{e}, const NodeIt @var{n}) 163 @deftypefunx SymEdgeIt Graph::getFirst (const SymEdgeIt & @var{e}, const NodeIt @var{n}) 164 The edges leaving from, arriving at or adjacent with a node forms a 163 @c ??? What should be the return value ??? 164 @end deftypefun 165 166 @deftypefun InEdgeIt &Graph::getFirst (InEdgeIt & @var{e}, const NodeIt @var{n}) 167 @deftypefunx OutEdgeIt &Graph::getFirst (OutEdgeIt & @var{e}, const NodeIt @var{n}) 168 @c @deftypefunx SymEdgeIt &Graph::getFirst (SymEdgeIt & @var{e}, const NodeIt @var{n}) 169 The edges leaving from 170 or 171 arriving at 172 @c or adjacent with 173 a node forms a 165 174 list. These functions give back the first elements of these 166 175 lists. The exact behavior depends on the type of @var{e}. … … 170 179 of the node @var{n}, respectively. 171 180 172 If @var{e} is a @code{SymEdgeIt} then173 @c ode{getFirst} sets @var{e} to be the first incoming if there exists one174 otherwise the first outgoing edge.181 @c If @var{e} is a @code{SymEdgeIt} then 182 @c @code{getFirst} sets @var{e} to be the first incoming if there exists one 183 @c otherwise the first outgoing edge. 175 184 176 185 If there are no such edges, @var{e} will be invalid. … … 219 228 @code{bNode(e)} is the other end of the edge. 220 229 221 ???It is implemented in an other way now. (Member function <> Graph global)??? 230 @deftypefun void Graph::setInvalid (EdgeIt &@var{e}) 231 @deftypefunx void Graph::setInvalid (EdgeIt &@var{e}) 232 These functions set the corresponding iterator to be invalid. 233 @end deftypefun 234 235 @c ???It is implemented in an other way now. (Member function <> Graph global)??? 222 236 @end deftypefun 223 237
Note: See TracChangeset
for help on using the changeset viewer.