Changeset 786:e20173729589 – LEMON

doc/min_cost_flow.dox

-                      r663
+                      r786
    - if \f$cost^\pi(uv)<0\f$, then \f$f(uv)=upper(uv)\f$.
  - For all \f$u\in V\f$ nodes:
    - \f$\pi(u)<=0\f$;
+   - \f$\pi(u)\leq 0\f$;
    - if \f$\sum_{uv\in A} f(uv) - \sum_{vu\in A} f(vu) \neq sup(u)\f$,
      then \f$\pi(u)=0\f$.
 …
    - if \f$cost^\pi(uv)<0\f$, then \f$f(uv)=upper(uv)\f$.
  - For all \f$u\in V\f$ nodes:
    - \f$\pi(u)>=0\f$;
+   - \f$\pi(u)\geq 0\f$;
    - if \f$\sum_{uv\in A} f(uv) - \sum_{vu\in A} f(vu) \neq sup(u)\f$,
      then \f$\pi(u)=0\f$.

lemon/bellman_ford.h

-                      r699
+                      r786
     /// \ref named-templ-param "Named parameter" for setting
     /// \c OperationTraits type.
     /// For more information see \ref BellmanFordDefaultOperationTraits.
+    /// For more information, see \ref BellmanFordDefaultOperationTraits.
     template <class T>
     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

-                      r717
+                      r786
     ///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<typename Digraph::Node,bool> 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<typename Digraph::Node,bool> ProcessedMap;
     ///Instantiates a ProcessedMap.

lemon/circulation.h

r715	r786
307	307	/// able to automatically created by the algorithm (i.e. the
308	308	/// digraph and the maximum level should be passed to it).
309		/// However an external elevator object could also be passed to the
	309	/// However, an external elevator object could also be passed to the
310	310	/// algorithm with the \ref elevator(Elevator&) "elevator()" function
311	311	/// before calling \ref run() or \ref init().

lemon/concepts/digraph.h

-                      r734
+                      r786
       /// 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

-                      r734
+                      r786
       /// 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

r734	r786
19	19	///\ingroup graph_concepts
20	20	///\file
21		///\brief The concept of graph components.
	21	///\brief The concepts of graph components.
22	22
23	23	#ifndef LEMON_CONCEPTS_GRAPH_COMPONENTS_H

lemon/counter.h

r440	r786
213	213	/// 'Do nothing' version of Counter.
214	214
215		/// This class can be used in the same way as \ref Counter ~~however~~ it
	215	/// This class can be used in the same way as \ref Counter, but it
216	216	/// does not count at all and does not print report on destruction.
217	217	///

lemon/dfs.h

-                      r717
+                      r786
     ///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<typename Digraph::Node,bool> 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<typename Digraph::Node,bool> ProcessedMap;
     ///Instantiates a ProcessedMap.

lemon/dijkstra.h

-                      r717
+                      r786
     ///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<typename Digraph::Node,bool> 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 <class T>
     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<typename Digraph::Node,bool> ProcessedMap;
     ///Instantiates a ProcessedMap.

lemon/gomory_hu.h

-                      r713
+                      r786
     /// \pre \ref run() must be called before using this function.
     template <typename CutMap>
     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

-                      r617
+                      r786
   ///\param gr  Reference to the graph to be printed.
   ///\param ost Reference to the output stream.
   ///By default it is <tt>std::cout</tt>.
+  ///By default, it is <tt>std::cout</tt>.
   ///\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 <tt>std::cout</tt>.
+///By default, it is <tt>std::cout</tt>.
 ///
 ///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

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

lemon/lgf_reader.h

-                      r599
+                      r786
   ///\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

-                      r741
+                      r786
     ///
     ///\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

-                      r746
+                      r786
     ///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

-                      r726
+                      r786
   /// This map is essentially a wrapper for \c std::vector. It assigns
   /// values to integer keys from the range <tt>[0..size-1]</tt>.
   /// 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

lemon/network_simplex.h

-                      r730
+                      r786
   /// in LEMON for the minimum cost flow problem.
   /// Moreover it supports both directions of the supply/demand inequality
   /// constraints. For more information see \ref SupplyType.
+  /// constraints. For more information, see \ref SupplyType.
   ///
   /// Most of the parameters of the problem (except for the digraph)
 …
   /// \tparam GR The digraph type the algorithm runs on.
   /// \tparam V The value type used for flow amounts, capacity bounds
   /// and supply values in the algorithm. By default it is \c int.
+  /// and supply values in the algorithm. By default, it is \c int.
   /// \tparam C The value type used for costs and potentials in the
   /// algorithm. By default it is the same as \c V.
+  /// algorithm. By default, it is the same as \c V.
   ///
   /// \warning Both value types must be signed and all input data must
 …
   /// \note %NetworkSimplex provides five different pivot rule
   /// implementations, from which the most efficient one is used
   /// by default. For more information see \ref PivotRule.
+  /// by default. For more information, see \ref PivotRule.
   template <typename GR, typename V = int, typename C = V>
   class NetworkSimplex
 …
     /// implementations that significantly affect the running time
     /// of the algorithm.
     /// By default \ref BLOCK_SEARCH "Block Search" is used, which
+    /// By default, \ref BLOCK_SEARCH "Block Search" is used, which
     /// proved to be the most efficient and the most robust on various
     /// test inputs according to our benchmark tests.
     /// However another pivot rule can be selected using the \ref run()
+    /// However, another pivot rule can be selected using the \ref run()
     /// function with the proper parameter.
     enum PivotRule {
       /// The First Eligible pivot rule.
+      /// The \e First \e Eligible pivot rule.
       /// The next eligible arc is selected in a wraparound fashion
       /// in every iteration.
       FIRST_ELIGIBLE,
       /// The Best Eligible pivot rule.
+      /// The \e Best \e Eligible pivot rule.
       /// The best eligible arc is selected in every iteration.
       BEST_ELIGIBLE,
       /// The Block Search pivot rule.
+      /// The \e Block \e Search pivot rule.
       /// A specified number of arcs are examined in every iteration
       /// in a wraparound fashion and the best eligible arc is selected
 …
       BLOCK_SEARCH,
       /// The Candidate List pivot rule.
+      /// The \e Candidate \e List pivot rule.
       /// In a major iteration a candidate list is built from eligible arcs
       /// in a wraparound fashion and in the following minor iterations
 …
       CANDIDATE_LIST,
       /// The Altering Candidate List pivot rule.
+      /// The \e Altering \e Candidate \e List pivot rule.
       /// It is a modified version of the Candidate List method.
       /// It keeps only the several best eligible arcs from the former
 …
     /// type will be used.
     ///
     /// For more information see \ref SupplyType.
+    /// For more information, see \ref SupplyType.
     ///
     /// \return <tt>(*this)</tt>
 …
     /// \ref reset() is called, thus only the modified parameters
     /// have to be set again. See \ref reset() for examples.
     /// However the underlying digraph must not be modified after this
+    /// However, the underlying digraph must not be modified after this
     /// class have been constructed, since it copies and extends the graph.
     ///
     /// \param pivot_rule The pivot rule that will be used during the
     /// algorithm. For more information see \ref PivotRule.
+    /// algorithm. For more information, see \ref PivotRule.
     ///
     /// \return \c INFEASIBLE if no feasible flow exists,
 …
     /// used, all the parameters given before are kept for the next
     /// \ref run() call.
     /// However the underlying digraph must not be modified after this
+    /// However, the underlying digraph must not be modified after this
     /// class have been constructed, since it copies and extends the graph.
     ///

lemon/preflow.h

r715	r786
265	265	/// able to automatically created by the algorithm (i.e. the
266	266	/// digraph and the maximum level should be passed to it).
267		/// However an external elevator object could also be passed to the
	267	/// However, an external elevator object could also be passed to the
268	268	/// algorithm with the \ref elevator(Elevator&) "elevator()" function
269	269	/// before calling \ref run() or \ref init().

lemon/time_measure.h

r584	r786
376	376	///This function returns the number of stop() exections that is
377	377	///necessary to really stop the timer.
378		///For example the timer
	378	///For example, the timer
379	379	///is running if and only if the return value is \c true
380	380	///(i.e. greater than

lemon/unionfind.h

r559	r786
44	44	/// This is a very simple but efficient implementation, providing
45	45	/// only four methods: join (union), find, insert and size.
46		/// For more features see the \ref UnionFindEnum class.
	46	/// For more features, see the \ref UnionFindEnum class.
47	47	///
48	48	/// It is primarily used in Kruskal algorithm for finding minimal

Context Navigation

Changeset 786:e20173729589 in lemon-main

Legend:

doc/min_cost_flow.dox

lemon/bellman_ford.h

lemon/bfs.h

lemon/circulation.h

lemon/concepts/digraph.h

lemon/concepts/graph.h

lemon/concepts/graph_components.h

lemon/counter.h

lemon/dfs.h

lemon/dijkstra.h

lemon/gomory_hu.h

lemon/graph_to_eps.h

lemon/hypercube_graph.h

lemon/lgf_reader.h

lemon/list_graph.h

lemon/lp_base.h

lemon/maps.h

lemon/network_simplex.h

lemon/preflow.h

lemon/time_measure.h

lemon/unionfind.h

Download in other formats: