# Changeset 833:e20173729589 in lemon for lemon

Ignore:
Timestamp:
11/13/09 18:10:06 (12 years ago)
Branch:
default
Phase:
public
Message:

Small doc fixes in several files (#331)

Location:
lemon
Files:
20 edited

Unmodified
Removed
• ## lemon/bellman_ford.h

 r746 /// \ref named-templ-param "Named parameter" for setting /// \c OperationTraits type. /// For more information see \ref BellmanFordDefaultOperationTraits. /// For more information, see \ref BellmanFordDefaultOperationTraits. template struct SetOperationTraits /// /// The shortest path tree used here is equal to the shortest path /// tree used in \ref predNode() and \predMap(). /// tree used in \ref predNode() and \ref predMap(). /// /// \pre Either \ref run() or \ref init() must be called before /// /// The shortest path tree used here is equal to the shortest path /// tree used in \ref predArc() and \predMap(). /// tree used in \ref predArc() and \ref predMap(). /// /// \pre Either \ref run() or \ref init() must be called before
• ## lemon/bfs.h

 r764 ///The type of the map that indicates which nodes are processed. ///It must conform to the \ref concepts::WriteMap "WriteMap" concept. ///By default it is a NullMap. ///By default, it is a NullMap. typedef NullMap ProcessedMap; ///Instantiates a \c ProcessedMap. ///The type of the map that indicates which nodes are processed. ///It must conform to the \ref concepts::WriteMap "WriteMap" concept. ///By default it is a NullMap. ///By default, it is a NullMap. typedef NullMap ProcessedMap; ///Instantiates a ProcessedMap.
• ## lemon/circulation.h

 r762 /// able to automatically created by the algorithm (i.e. the /// digraph and the maximum level should be passed to it). /// However an external elevator object could also be passed to the /// However, an external elevator object could also be passed to the /// algorithm with the \ref elevator(Elevator&) "elevator()" function /// before calling \ref run() or \ref init().
• ## lemon/concepts/digraph.h

 r781 /// This iterator goes through each node of the digraph. /// Its usage is quite simple, for example you can count the number /// Its usage is quite simple, for example, you can count the number /// of nodes in a digraph \c g of type \c %Digraph like this: ///\code /// This iterator goes trough the \e outgoing arcs of a certain node /// of a digraph. /// Its usage is quite simple, for example you can count the number /// Its usage is quite simple, for example, you can count the number /// of outgoing arcs of a node \c n /// in a digraph \c g of type \c %Digraph as follows. /// This iterator goes trough the \e incoming arcs of a certain node /// of a digraph. /// Its usage is quite simple, for example you can count the number /// Its usage is quite simple, for example, you can count the number /// of incoming arcs of a node \c n /// in a digraph \c g of type \c %Digraph as follows. /// This iterator goes through each arc of the digraph. /// Its usage is quite simple, for example you can count the number /// Its usage is quite simple, for example, you can count the number /// of arcs in a digraph \c g of type \c %Digraph as follows: ///\code
• ## lemon/concepts/graph.h

 r781 /// This iterator goes through each node of the graph. /// Its usage is quite simple, for example you can count the number /// Its usage is quite simple, for example, you can count the number /// of nodes in a graph \c g of type \c %Graph like this: ///\code /// This iterator goes through each edge of the graph. /// Its usage is quite simple, for example you can count the number /// Its usage is quite simple, for example, you can count the number /// of edges in a graph \c g of type \c %Graph as follows: ///\code /// This iterator goes trough the incident undirected edges /// of a certain node of a graph. /// Its usage is quite simple, for example you can compute the /// Its usage is quite simple, for example, you can compute the /// degree (i.e. the number of incident edges) of a node \c n /// in a graph \c g of type \c %Graph as follows. /// This iterator goes through each directed arc of the graph. /// Its usage is quite simple, for example you can count the number /// Its usage is quite simple, for example, you can count the number /// of arcs in a graph \c g of type \c %Graph as follows: ///\code /// This iterator goes trough the \e outgoing directed arcs of a /// certain node of a graph. /// Its usage is quite simple, for example you can count the number /// Its usage is quite simple, for example, you can count the number /// of outgoing arcs of a node \c n /// in a graph \c g of type \c %Graph as follows. /// This iterator goes trough the \e incoming directed arcs of a /// certain node of a graph. /// Its usage is quite simple, for example you can count the number /// Its usage is quite simple, for example, you can count the number /// of incoming arcs of a node \c n /// in a graph \c g of type \c %Graph as follows. /// Returns the first node of the given edge. /// /// Edges don't have source and target nodes, however methods /// Edges don't have source and target nodes, however, methods /// u() and v() are used to query the two end-nodes of an edge. /// The orientation of an edge that arises this way is called /// Returns the second node of the given edge. /// /// Edges don't have source and target nodes, however methods /// Edges don't have source and target nodes, however, methods /// u() and v() are used to query the two end-nodes of an edge. /// The orientation of an edge that arises this way is called
• ## lemon/concepts/graph_components.h

 r781 ///\ingroup graph_concepts ///\file ///\brief The concept of graph components. ///\brief The concepts of graph components. #ifndef LEMON_CONCEPTS_GRAPH_COMPONENTS_H
• ## lemon/counter.h

 r463 /// 'Do nothing' version of Counter. /// This class can be used in the same way as \ref Counter however it /// This class can be used in the same way as \ref Counter, but it /// does not count at all and does not print report on destruction. ///
• ## lemon/dfs.h

 r764 ///The type of the map that indicates which nodes are processed. ///It must conform to the \ref concepts::WriteMap "WriteMap" concept. ///By default it is a NullMap. ///By default, it is a NullMap. typedef NullMap ProcessedMap; ///Instantiates a \c ProcessedMap. ///The type of the map that indicates which nodes are processed. ///It must conform to the \ref concepts::WriteMap "WriteMap" concept. ///By default it is a NullMap. ///By default, it is a NullMap. typedef NullMap ProcessedMap; ///Instantiates a ProcessedMap.
• ## lemon/dijkstra.h

 r764 ///The type of the map that indicates which nodes are processed. ///It must conform to the \ref concepts::WriteMap "WriteMap" concept. ///By default it is a NullMap. ///By default, it is a NullMap. typedef NullMap ProcessedMap; ///Instantiates a \c ProcessedMap. ///passed to the constructor of the cross reference and the cross ///reference should be passed to the constructor of the heap). ///However external heap and cross reference objects could also be ///However, external heap and cross reference objects could also be ///passed to the algorithm using the \ref heap() function before ///calling \ref run(Node) "run()" or \ref init(). ///\ref named-templ-param "Named parameter" for setting ///\c OperationTraits type. /// For more information see \ref DijkstraDefaultOperationTraits. /// For more information, see \ref DijkstraDefaultOperationTraits. template struct SetOperationTraits ///The type of the map that indicates which nodes are processed. ///It must conform to the \ref concepts::WriteMap "WriteMap" concept. ///By default it is a NullMap. ///By default, it is a NullMap. typedef NullMap ProcessedMap; ///Instantiates a ProcessedMap.
• ## lemon/gomory_hu.h

 r760 /// \pre \ref run() must be called before using this function. template Value minCutMap(const Node& s, ///< Value minCutMap(const Node& s, const Node& t, ///< CutMap& cutMap ///< ) const { Node sn = s, tn = t; /// \endcode /// does not necessarily give the same set of nodes. /// However it is ensured that /// However, it is ensured that /// \code /// MinCutNodeIt(gomory, s, t, true);
• ## lemon/graph_to_eps.h

 r664 ///\param gr  Reference to the graph to be printed. ///\param ost Reference to the output stream. ///By default it is std::cout. ///By default, it is std::cout. ///\param pros If it is \c true, then the \c ostream referenced by \c os ///will be explicitly deallocated by the destructor. ///Turn on/off pre-scaling ///By default graphToEps() rescales the whole image in order to avoid ///By default, graphToEps() rescales the whole image in order to avoid ///very big or very small bounding boxes. /// ///\param g Reference to the graph to be printed. ///\param os Reference to the output stream. ///By default it is std::cout. ///By default, it is std::cout. /// ///This function also has a lot of ///\endcode /// ///For more detailed examples see the \ref graph_to_eps_demo.cc demo file. ///For more detailed examples, see the \ref graph_to_eps_demo.cc demo file. /// ///\warning Don't forget to put the \ref GraphToEps::run() "run()"
• ## lemon/hypercube_graph.h

 r784 /// differ only on one position in the binary form. /// This class is completely static and it needs constant memory space. /// Thus you can neither add nor delete nodes or edges, however /// Thus you can neither add nor delete nodes or edges, however, /// the structure can be resized using resize(). ///

 r646 ///\endcode /// /// By default the reader uses the first section in the file of the /// By default, the reader uses the first section in the file of the /// proper type. If a section has an optional name, then it can be /// selected for reading by giving an optional name parameter to the /// whitespaces are trimmed from each processed string. /// /// For example let's see a section, which contain several /// For example, let's see a section, which contain several /// integers, which should be inserted into a vector. ///\code
• ## lemon/list_graph.h

 r788 /// ///\note \c ArcIt and \c OutArcIt iterators referencing the changed ///arc remain valid, however \c InArcIt iterators are invalidated. ///arc remain valid, but \c InArcIt iterators are invalidated. /// ///\warning This functionality cannot be used together with the Snapshot /// ///\note \c InArcIt iterators referencing the changed arc remain ///valid, however \c ArcIt and \c OutArcIt iterators are invalidated. ///valid, but \c ArcIt and \c OutArcIt iterators are invalidated. /// ///\warning This functionality cannot be used together with the Snapshot /// reversing, contracting, splitting arcs or nodes) cannot be /// restored. These events invalidate the snapshot. /// However the arcs and nodes that were added to the digraph after /// However, the arcs and nodes that were added to the digraph after /// making the current snapshot can be removed without invalidating it. class Snapshot { /// ///\note \c EdgeIt iterators referencing the changed edge remain ///valid, however \c ArcIt iterators referencing the changed edge and ///valid, but \c ArcIt iterators referencing the changed edge and ///all other iterators whose base node is the changed node are also ///invalidated. /// (e.g. changing the end-nodes of edges or contracting nodes) /// cannot be restored. These events invalidate the snapshot. /// However the edges and nodes that were added to the graph after /// However, the edges and nodes that were added to the graph after /// making the current snapshot can be removed without invalidating it. class Snapshot {
• ## lemon/lp_base.h

 r793 ///Iterator for iterate over the columns of an LP problem /// Its usage is quite simple, for example you can count the number /// Its usage is quite simple, for example, you can count the number /// of columns in an LP \c lp: ///\code ///Iterator for iterate over the rows of an LP problem /// Its usage is quite simple, for example you can count the number /// Its usage is quite simple, for example, you can count the number /// of rows in an LP \c lp: ///\code
• ## lemon/maps.h

 r773 /// This map is essentially a wrapper for \c std::vector. It assigns /// values to integer keys from the range [0..size-1]. /// It can be used with some data structures, for example /// \c UnionFind, \c BinHeap, when the used items are small /// It can be used together with some data structures, e.g. /// heap types and \c UnionFind, when the used items are small /// integers. This map conforms to the \ref concepts::ReferenceMap /// "ReferenceMap" concept. /// "ReferenceMap" concept. /// /// The simplest way of using this map is through the rangeMap() /// The name of this type also refers to this important usage. /// /// Apart form that this map can be used in many other cases since it /// Apart form that, this map can be used in many other cases since it /// is based on \c std::map, which is a general associative container. /// However keep in mind that it is usually not as efficient as other /// However, keep in mind that it is usually not as efficient as other /// maps. /// /// The most important usage of it is storing certain nodes or arcs /// that were marked \c true by an algorithm. /// For example it makes easier to store the nodes in the processing /// For example, it makes easier to store the nodes in the processing /// order of Dfs algorithm, as the following examples show. /// \code /// /// \note LoggerBoolMap is just \ref concepts::WriteMap "writable", so /// it cannot be used when a readable map is needed, for example as /// it cannot be used when a readable map is needed, for example, as /// \c ReachedMap for \c Bfs, \c Dfs and \c Dijkstra algorithms. /// /// Otherwise consider to use \c IterableValueMap, which is more /// suitable and more efficient for such cases. It provides iterators /// to traverse the items with the same associated value, however /// to traverse the items with the same associated value, but /// it does not have \c InverseMap. /// /// may provide alternative ways to modify the digraph. /// The correct behavior of InDegMap is not guarantied if these additional /// features are used. For example the functions /// features are used. For example, the functions /// \ref ListDigraph::changeSource() "changeSource()", /// \ref ListDigraph::changeTarget() "changeTarget()" and /// may provide alternative ways to modify the digraph. /// The correct behavior of OutDegMap is not guarantied if these additional /// features are used. For example the functions /// features are used. For example, the functions /// \ref ListDigraph::changeSource() "changeSource()", /// \ref ListDigraph::changeTarget() "changeTarget()" and