LEMON/LEMON-main Changeset - r584:33c6b6e755cd

Repositories » LEMON » LEMON-main

Summary
Changelog
Files
Switch To
- loading...
Options
- Lightweight changelog
- Search
Pull Requests

Changeset - r584:33c6b6e755cd

« 583:99a31b

588:58f704 »

r584:33c6b6e755cd

Wed, 15 Apr 2009 02:04:37

[Not Reviewed]

0 comments (0 inline)

kpeter (Peter Kovacs)
kpeter@inf.elte.hu

Small doc improvements (#263)

0 19 0

default

19 files changed with 118 insertions and 125 deletions:

lemon/bin_heap.h

lemon/concepts/graph_components.h

lemon/concepts/heap.h

lemon/dfs.h

lemon/dijkstra.h

lemon/dimacs.h

lemon/graph_to_eps.h

lemon/kruskal.h

lemon/lgf_reader.h

lemon/lgf_writer.h

lemon/lp_base.h

lemon/maps.h

lemon/min_cost_arborescence.h

lemon/random.h

lemon/suurballe.h

lemon/time_measure.h

tools/dimacs-solver.cc

tools/dimacs-to-lgf.cc

tools/lgf-gen.cc

↑ Collapse diff ↑

lemon/bin_heap.h

Show inline comments

@@ -28,99 +28,99 @@
 		#include <functional>
 		namespace lemon {
 		  ///\ingroup auxdat
 		  ///
 		  ///\brief A Binary Heap implementation.
 		  ///
 		  ///This class implements the \e binary \e heap data structure.
 		  ///
 		  ///A \e heap is a data structure for storing items with specified values
 		  ///called \e priorities in such a way that finding the item with minimum
 		  ///priority is efficient. \c Comp specifies the ordering of the priorities.
 		  ///In a heap one can change the priority of an item, add or erase an
 		  ///item, etc.
 		  ///
 		  ///\tparam PR Type of the priority of the items.
 		  ///\tparam IM A read and writable item map with int values, used internally
 		  ///to handle the cross references.
 		  ///\tparam Comp A functor class for the ordering of the priorities.
 		  ///The default is \c std::less<PR>.
 		  ///
 		  ///\sa FibHeap
 		  ///\sa Dijkstra
 		  template <typename PR, typename IM, typename Comp = std::less<PR> >
 		  class BinHeap {
 		  public:
 		    ///\e
 		    typedef IM ItemIntMap;
 		    ///\e
 		    typedef PR Prio;
 		    ///\e
 		    typedef typename ItemIntMap::Key Item;
 		    ///\e
 		    typedef std::pair<Item,Prio> Pair;
 		    ///\e
 		    typedef Comp Compare;
 		    /// \brief Type to represent the items states.
 		    ///
 		    /// Each Item element have a state associated to it. It may be "in heap",
 		    /// "pre heap" or "post heap". The latter two are indifferent from the
 		    /// heap's point of view, but may be useful to the user.
 		    ///
 		    /// The item-int map must be initialized in such way that it assigns
 		    /// \c PRE_HEAP (<tt>-1</tt>) to any element to be put in the heap.
 		    enum State {
 		      IN_HEAP = 0,    ///< \e
 		      PRE_HEAP = -1,  ///< \e
-		      POST_HEAP = -2  ///< \e
+		      IN_HEAP = 0,    ///< = 0.
 		      PRE_HEAP = -1,  ///< = -1.
 		      POST_HEAP = -2  ///< = -2.
 		    };
 		  private:
 		    std::vector<Pair> _data;
 		    Compare _comp;
 		    ItemIntMap &_iim;
 		  public:
 		    /// \brief The constructor.
 		    ///
 		    /// The constructor.
 		    /// \param map should be given to the constructor, since it is used
 		    /// internally to handle the cross references. The value of the map
 		    /// must be \c PRE_HEAP (<tt>-1</tt>) for every item.
 		    explicit BinHeap(ItemIntMap &map) : _iim(map) {}
 		    /// \brief The constructor.
 		    ///
 		    /// The constructor.
 		    /// \param map should be given to the constructor, since it is used
 		    /// internally to handle the cross references. The value of the map
 		    /// should be PRE_HEAP (-1) for each element.
 		    ///
 		    /// \param comp The comparator function object.
 		    BinHeap(ItemIntMap &map, const Compare &comp)
 		      : _iim(map), _comp(comp) {}
 		    /// The number of items stored in the heap.
 		    ///
 		    /// \brief Returns the number of items stored in the heap.
 		    int size() const { return _data.size(); }
 		    /// \brief Checks if the heap stores no items.
 		    ///
 		    /// Returns \c true if and only if the heap stores no items.
 		    bool empty() const { return _data.empty(); }
 		    /// \brief Make empty this heap.
 		    ///
 		    /// Make empty this heap. It does not change the cross reference map.
 		    /// If you want to reuse what is not surely empty you should first clear
 		    /// the heap and after that you should set the cross reference map for
 		    /// each item to \c PRE_HEAP.
 		    void clear() {
 		      _data.clear();
+		    }

lemon/concepts/graph_components.h

Show inline comments

@@ -557,149 +557,149 @@
 		      /// Two iterators are equal if and only if they point to the
 		      /// same object or both are invalid.
 		      bool operator==(const GraphIncIt&) const { return true;}
 		      /// \brief Inequality operator
 		      ///
 		      /// Inequality operator.
 		      /// Two iterators are equal if and only if they point to the
 		      /// same object or both are invalid.
 		      bool operator!=(const GraphIncIt&) const { return true;}
 		      template <typename _GraphIncIt>
 		      struct Constraints {
 		        void constraints() {
 		          checkConcept<GraphItem<sel>, _GraphIncIt>();
 		          _GraphIncIt it1(graph, node);
 		          _GraphIncIt it2;
 		          _GraphIncIt it3 = it1;
 		          _GraphIncIt it4 = INVALID;
 		          it2 = ++it1;
 		          ++it2 = it1;
 		          ++(++it1);
 		          Item e = it1;
 		          e = it2;
+		        }
 		        const Base& node;
 		        const GR& graph;
 		      };
 		    };
 		    /// \brief Skeleton class for iterable directed graphs.
 		    ///
 		    /// This class describes the interface of iterable directed
 		    /// graphs. It extends \ref BaseDigraphComponent with the core
 		    /// iterable interface.
 		    /// This concept is part of the Digraph concept.
 		    template <typename BAS = BaseDigraphComponent>
 		    class IterableDigraphComponent : public BAS {
 		    public:
 		      typedef BAS Base;
 		      typedef typename Base::Node Node;
 		      typedef typename Base::Arc Arc;
 		      typedef IterableDigraphComponent Digraph;
-		      /// \name Base iteration
+		      /// \name Base Iteration
 		      ///
 		      /// This interface provides functions for iteration on digraph items.
 		      ///
 		      /// @{
 		      /// \brief Return the first node.
 		      ///
 		      /// This function gives back the first node in the iteration order.
 		      void first(Node&) const {}
 		      /// \brief Return the next node.
 		      ///
 		      /// This function gives back the next node in the iteration order.
 		      void next(Node&) const {}
 		      /// \brief Return the first arc.
 		      ///
 		      /// This function gives back the first arc in the iteration order.
 		      void first(Arc&) const {}
 		      /// \brief Return the next arc.
 		      ///
 		      /// This function gives back the next arc in the iteration order.
 		      void next(Arc&) const {}
 		      /// \brief Return the first arc incomming to the given node.
 		      ///
 		      /// This function gives back the first arc incomming to the
 		      /// given node.
 		      void firstIn(Arc&, const Node&) const {}
 		      /// \brief Return the next arc incomming to the given node.
 		      ///
 		      /// This function gives back the next arc incomming to the
 		      /// given node.
 		      void nextIn(Arc&) const {}
 		      /// \brief Return the first arc outgoing form the given node.
 		      ///
 		      /// This function gives back the first arc outgoing form the
 		      /// given node.
 		      void firstOut(Arc&, const Node&) const {}
 		      /// \brief Return the next arc outgoing form the given node.
 		      ///
 		      /// This function gives back the next arc outgoing form the
 		      /// given node.
 		      void nextOut(Arc&) const {}
 		      /// @}
-		      /// \name Class based iteration
+		      /// \name Class Based Iteration
 		      ///
 		      /// This interface provides iterator classes for digraph items.
 		      ///
 		      /// @{
 		      /// \brief This iterator goes through each node.
 		      ///
 		      /// This iterator goes through each node.
 		      ///
 		      typedef GraphItemIt<Digraph, Node> NodeIt;
 		      /// \brief This iterator goes through each arc.
 		      ///
 		      /// This iterator goes through each arc.
 		      ///
 		      typedef GraphItemIt<Digraph, Arc> ArcIt;
 		      /// \brief This iterator goes trough the incoming arcs of a node.
 		      ///
 		      /// This iterator goes trough the \e incoming arcs of a certain node
 		      /// of a digraph.
 		      typedef GraphIncIt<Digraph, Arc, Node, 'i'> InArcIt;
 		      /// \brief This iterator goes trough the outgoing arcs of a node.
 		      ///
 		      /// This iterator goes trough the \e outgoing arcs of a certain node
 		      /// of a digraph.
 		      typedef GraphIncIt<Digraph, Arc, Node, 'o'> OutArcIt;
 		      /// \brief The base node of the iterator.
 		      ///
 		      /// This function gives back the base node of the iterator.
 		      /// It is always the target node of the pointed arc.
 		      Node baseNode(const InArcIt&) const { return INVALID; }
 		      /// \brief The running node of the iterator.
 		      ///
 		      /// This function gives back the running node of the iterator.
 		      /// It is always the source node of the pointed arc.
 		      Node runningNode(const InArcIt&) const { return INVALID; }
 		      /// \brief The base node of the iterator.
 		      ///
 		      /// This function gives back the base node of the iterator.
 		      /// It is always the source node of the pointed arc.
 		      Node baseNode(const OutArcIt&) const { return INVALID; }
 		      /// \brief The running node of the iterator.
@@ -734,136 +734,136 @@
 		              digraph.firstOut(arc, node);
 		              digraph.nextOut(arc);
+		            }
+		          }
+		          {
 		            checkConcept<GraphItemIt<_Digraph, typename _Digraph::Arc>,
 		              typename _Digraph::ArcIt >();
 		            checkConcept<GraphItemIt<_Digraph, typename _Digraph::Node>,
 		              typename _Digraph::NodeIt >();
 		            checkConcept<GraphIncIt<_Digraph, typename _Digraph::Arc,
 		              typename _Digraph::Node, 'i'>, typename _Digraph::InArcIt>();
 		            checkConcept<GraphIncIt<_Digraph, typename _Digraph::Arc,
 		              typename _Digraph::Node, 'o'>, typename _Digraph::OutArcIt>();
 		            typename _Digraph::Node n;
 		            const typename _Digraph::InArcIt iait(INVALID);
 		            const typename _Digraph::OutArcIt oait(INVALID);
 		            n = digraph.baseNode(iait);
 		            n = digraph.runningNode(iait);
 		            n = digraph.baseNode(oait);
 		            n = digraph.runningNode(oait);
 		            ignore_unused_variable_warning(n);
+		          }
+		        }
 		        const _Digraph& digraph;
 		      };
 		    };
 		    /// \brief Skeleton class for iterable undirected graphs.
 		    ///
 		    /// This class describes the interface of iterable undirected
 		    /// graphs. It extends \ref IterableDigraphComponent with the core
 		    /// iterable interface of undirected graphs.
 		    /// This concept is part of the Graph concept.
 		    template <typename BAS = BaseGraphComponent>
 		    class IterableGraphComponent : public IterableDigraphComponent<BAS> {
 		    public:
 		      typedef BAS Base;
 		      typedef typename Base::Node Node;
 		      typedef typename Base::Arc Arc;
 		      typedef typename Base::Edge Edge;
 		      typedef IterableGraphComponent Graph;
-		      /// \name Base iteration
+		      /// \name Base Iteration
 		      ///
 		      /// This interface provides functions for iteration on edges.
 		      ///
 		      /// @{
 		      using IterableDigraphComponent<Base>::first;
 		      using IterableDigraphComponent<Base>::next;
 		      /// \brief Return the first edge.
 		      ///
 		      /// This function gives back the first edge in the iteration order.
 		      void first(Edge&) const {}
 		      /// \brief Return the next edge.
 		      ///
 		      /// This function gives back the next edge in the iteration order.
 		      void next(Edge&) const {}
 		      /// \brief Return the first edge incident to the given node.
 		      ///
 		      /// This function gives back the first edge incident to the given
 		      /// node. The bool parameter gives back the direction for which the
 		      /// source node of the directed arc representing the edge is the
 		      /// given node.
 		      void firstInc(Edge&, bool&, const Node&) const {}
 		      /// \brief Gives back the next of the edges from the
 		      /// given node.
 		      ///
 		      /// This function gives back the next edge incident to the given
 		      /// node. The bool parameter should be used as \c firstInc() use it.
 		      void nextInc(Edge&, bool&) const {}
 		      using IterableDigraphComponent<Base>::baseNode;
 		      using IterableDigraphComponent<Base>::runningNode;
 		      /// @}
-		      /// \name Class based iteration
+		      /// \name Class Based Iteration
 		      ///
 		      /// This interface provides iterator classes for edges.
 		      ///
 		      /// @{
 		      /// \brief This iterator goes through each edge.
 		      ///
 		      /// This iterator goes through each edge.
 		      typedef GraphItemIt<Graph, Edge> EdgeIt;
 		      /// \brief This iterator goes trough the incident edges of a
 		      /// node.
 		      ///
 		      /// This iterator goes trough the incident edges of a certain
 		      /// node of a graph.
 		      typedef GraphIncIt<Graph, Edge, Node, 'e'> IncEdgeIt;
 		      /// \brief The base node of the iterator.
 		      ///
 		      /// This function gives back the base node of the iterator.
 		      Node baseNode(const IncEdgeIt&) const { return INVALID; }
 		      /// \brief The running node of the iterator.
 		      ///
 		      /// This function gives back the running node of the iterator.
 		      Node runningNode(const IncEdgeIt&) const { return INVALID; }
 		      /// @}
 		      template <typename _Graph>
 		      struct Constraints {
 		        void constraints() {
 		          checkConcept<IterableDigraphComponent<Base>, _Graph>();
+		          {
 		            typename _Graph::Node node(INVALID);
 		            typename _Graph::Edge edge(INVALID);
 		            bool dir;
+		            {
 		              graph.first(edge);
 		              graph.next(edge);
+		            }
+		            {
 		              graph.firstInc(edge, dir, node);
 		              graph.nextInc(edge, dir);
+		            }
+		          }

lemon/concepts/heap.h

Show inline comments

@@ -26,99 +26,99 @@
 		#include <lemon/core.h>
 		#include <lemon/concept_check.h>
 		namespace lemon {
 		  namespace concepts {
 		    /// \addtogroup concept
 		    /// @{
 		    /// \brief The heap concept.
 		    ///
 		    /// Concept class describing the main interface of heaps. A \e heap
 		    /// is a data structure for storing items with specified values called
 		    /// \e priorities in such a way that finding the item with minimum
 		    /// priority is efficient. In a heap one can change the priority of an
 		    /// item, add or erase an item, etc.
 		    ///
 		    /// \tparam PR Type of the priority of the items.
 		    /// \tparam IM A read and writable item map with int values, used
 		    /// internally to handle the cross references.
 		    /// \tparam Comp A functor class for the ordering of the priorities.
 		    /// The default is \c std::less<PR>.
 		#ifdef DOXYGEN
 		    template <typename PR, typename IM, typename Comp = std::less<PR> >
 		#else
 		    template <typename PR, typename IM>
 		#endif
 		    class Heap {
 		    public:
 		      /// Type of the item-int map.
 		      typedef IM ItemIntMap;
 		      /// Type of the priorities.
 		      typedef PR Prio;
 		      /// Type of the items stored in the heap.
 		      typedef typename ItemIntMap::Key Item;
 		      /// \brief Type to represent the states of the items.
 		      ///
 		      /// Each item has a state associated to it. It can be "in heap",
 		      /// "pre heap" or "post heap". The later two are indifferent
 		      /// from the point of view of the heap, but may be useful for
 		      /// the user.
 		      ///
 		      /// The item-int map must be initialized in such way that it assigns
 		      /// \c PRE_HEAP (<tt>-1</tt>) to any element to be put in the heap.
 		      enum State {
 		        IN_HEAP = 0,    ///< The "in heap" state constant.
 		        PRE_HEAP = -1,  ///< The "pre heap" state constant.
-		        POST_HEAP = -2  ///< The "post heap" state constant.
+		        IN_HEAP = 0,    ///< = 0. The "in heap" state constant.
 		        PRE_HEAP = -1,  ///< = -1. The "pre heap" state constant.
 		        POST_HEAP = -2  ///< = -2. The "post heap" state constant.
 		      };
 		      /// \brief The constructor.
 		      ///
 		      /// The constructor.
 		      /// \param map A map that assigns \c int values to keys of type
 		      /// \c Item. It is used internally by the heap implementations to
 		      /// handle the cross references. The assigned value must be
 		      /// \c PRE_HEAP (<tt>-1</tt>) for every item.
 		      explicit Heap(ItemIntMap &map) {}
 		      /// \brief The number of items stored in the heap.
 		      ///
 		      /// Returns the number of items stored in the heap.
 		      int size() const { return 0; }
 		      /// \brief Checks if the heap is empty.
 		      ///
 		      /// Returns \c true if the heap is empty.
 		      bool empty() const { return false; }
 		      /// \brief Makes the heap empty.
 		      ///
 		      /// Makes the heap empty.
 		      void clear();
 		      /// \brief Inserts an item into the heap with the given priority.
 		      ///
 		      /// Inserts the given item into the heap with the given priority.
 		      /// \param i The item to insert.
 		      /// \param p The priority of the item.
 		      void push(const Item &i, const Prio &p) {}
 		      /// \brief Returns the item having minimum priority.
 		      ///
 		      /// Returns the item having minimum priority.
 		      /// \pre The heap must be non-empty.
 		      Item top() const {}
 		      /// \brief The minimum priority.
 		      ///
 		      /// Returns the minimum priority.
 		      /// \pre The heap must be non-empty.
 		      Prio prio() const {}
 		      /// \brief Removes the item having minimum priority.
 		      ///
 		      /// Removes the item having minimum priority.

lemon/dfs.h

Show inline comments

@@ -161,97 +161,97 @@
 		    PredMap *_pred;
 		    //Indicates if _pred is locally allocated (true) or not.
 		    bool local_pred;
 		    //Pointer to the map of distances.
 		    DistMap *_dist;
 		    //Indicates if _dist is locally allocated (true) or not.
 		    bool local_dist;
 		    //Pointer to the map of reached status of the nodes.
 		    ReachedMap *_reached;
 		    //Indicates if _reached is locally allocated (true) or not.
 		    bool local_reached;
 		    //Pointer to the map of processed status of the nodes.
 		    ProcessedMap *_processed;
 		    //Indicates if _processed is locally allocated (true) or not.
 		    bool local_processed;
 		    std::vector<typename Digraph::OutArcIt> _stack;
 		    int _stack_head;
 		    //Creates the maps if necessary.
 		    void create_maps()
+		    {
 		      if(!_pred) {
 		        local_pred = true;
 		        _pred = Traits::createPredMap(*G);
+		      }
 		      if(!_dist) {
 		        local_dist = true;
 		        _dist = Traits::createDistMap(*G);
+		      }
 		      if(!_reached) {
 		        local_reached = true;
 		        _reached = Traits::createReachedMap(*G);
+		      }
 		      if(!_processed) {
 		        local_processed = true;
 		        _processed = Traits::createProcessedMap(*G);
+		      }
+		    }
 		  protected:
 		    Dfs() {}
 		  public:
 		    typedef Dfs Create;
-		    ///\name Named template parameters
+		    ///\name Named Template Parameters
 		    ///@{
 		    template <class T>
 		    struct SetPredMapTraits : public Traits {
 		      typedef T PredMap;
 		      static PredMap *createPredMap(const Digraph &)
+		      {
 		        LEMON_ASSERT(false, "PredMap is not initialized");
 		        return 0; // ignore warnings
+		      }
 		    };
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///\c PredMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///\c PredMap type.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    template <class T>
 		    struct SetPredMap : public Dfs<Digraph, SetPredMapTraits<T> > {
 		      typedef Dfs<Digraph, SetPredMapTraits<T> > Create;
 		    };
 		    template <class T>
 		    struct SetDistMapTraits : public Traits {
 		      typedef T DistMap;
 		      static DistMap *createDistMap(const Digraph &)
+		      {
 		        LEMON_ASSERT(false, "DistMap is not initialized");
 		        return 0; // ignore warnings
+		      }
 		    };
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///\c DistMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///\c DistMap type.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    template <class T>
 		    struct SetDistMap : public Dfs< Digraph, SetDistMapTraits<T> > {
 		      typedef Dfs<Digraph, SetDistMapTraits<T> > Create;
 		    };
 		    template <class T>
 		    struct SetReachedMapTraits : public Traits {
 		      typedef T ReachedMap;
 		      static ReachedMap *createReachedMap(const Digraph &)
+		      {

lemon/dijkstra.h

Show inline comments

@@ -241,97 +241,97 @@
 		    //Indicates if _pred is locally allocated (true) or not.
 		    bool local_pred;
 		    //Pointer to the map of distances.
 		    DistMap *_dist;
 		    //Indicates if _dist is locally allocated (true) or not.
 		    bool local_dist;
 		    //Pointer to the map of processed status of the nodes.
 		    ProcessedMap *_processed;
 		    //Indicates if _processed is locally allocated (true) or not.
 		    bool local_processed;
 		    //Pointer to the heap cross references.
 		    HeapCrossRef *_heap_cross_ref;
 		    //Indicates if _heap_cross_ref is locally allocated (true) or not.
 		    bool local_heap_cross_ref;
 		    //Pointer to the heap.
 		    Heap *_heap;
 		    //Indicates if _heap is locally allocated (true) or not.
 		    bool local_heap;
 		    //Creates the maps if necessary.
 		    void create_maps()
+		    {
 		      if(!_pred) {
 		        local_pred = true;
 		        _pred = Traits::createPredMap(*G);
+		      }
 		      if(!_dist) {
 		        local_dist = true;
 		        _dist = Traits::createDistMap(*G);
+		      }
 		      if(!_processed) {
 		        local_processed = true;
 		        _processed = Traits::createProcessedMap(*G);
+		      }
 		      if (!_heap_cross_ref) {
 		        local_heap_cross_ref = true;
 		        _heap_cross_ref = Traits::createHeapCrossRef(*G);
+		      }
 		      if (!_heap) {
 		        local_heap = true;
 		        _heap = Traits::createHeap(*_heap_cross_ref);
+		      }
+		    }
 		  public:
 		    typedef Dijkstra Create;
-		    ///\name Named template parameters
+		    ///\name Named Template Parameters
 		    ///@{
 		    template <class T>
 		    struct SetPredMapTraits : public Traits {
 		      typedef T PredMap;
 		      static PredMap *createPredMap(const Digraph &)
+		      {
 		        LEMON_ASSERT(false, "PredMap is not initialized");
 		        return 0; // ignore warnings
+		      }
 		    };
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///\c PredMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///\c PredMap type.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    template <class T>
 		    struct SetPredMap
 		      : public Dijkstra< Digraph, LengthMap, SetPredMapTraits<T> > {
 		      typedef Dijkstra< Digraph, LengthMap, SetPredMapTraits<T> > Create;
 		    };
 		    template <class T>
 		    struct SetDistMapTraits : public Traits {
 		      typedef T DistMap;
 		      static DistMap *createDistMap(const Digraph &)
+		      {
 		        LEMON_ASSERT(false, "DistMap is not initialized");
 		        return 0; // ignore warnings
+		      }
 		    };
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///\c DistMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///\c DistMap type.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    template <class T>
 		    struct SetDistMap
 		      : public Dijkstra< Digraph, LengthMap, SetDistMapTraits<T> > {
 		      typedef Dijkstra< Digraph, LengthMap, SetDistMapTraits<T> > Create;
 		    };
 		    template <class T>
 		    struct SetProcessedMapTraits : public Traits {
 		      typedef T ProcessedMap;

lemon/dimacs.h

Show inline comments

 		/* -*- mode: C++; indent-tabs-mode: nil; -*-
+		 *
 		 * This file is a part of LEMON, a generic C++ optimization library.
+		 *
 		 * Copyright (C) 2003-2009
 		 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
 		 * (Egervary Research Group on Combinatorial Optimization, EGRES).
+		 *
 		 * Permission to use, modify and distribute this software is granted
 		 * provided that this copyright notice appears in all copies. For
 		 * precise terms see the accompanying LICENSE file.
+		 *
 		 * This software is provided "AS IS" with no warranty of any kind,
 		 * express or implied, and with no claim as to its suitability for any
 		 * purpose.
+		 *
 		 */
 		#ifndef LEMON_DIMACS_H
 		#define LEMON_DIMACS_H
 		#include <iostream>
 		#include <string>
 		#include <vector>
 		#include <limits>
 		#include <lemon/maps.h>
 		#include <lemon/error.h>
 		/// \ingroup dimacs_group
 		/// \file
 		/// \brief DIMACS file format reader.
 		namespace lemon {
 		  /// \addtogroup dimacs_group
 		  /// @{
 		  /// DIMACS file type descriptor.
 		  struct DimacsDescriptor
+		  {
 		    ///File type enum
 		    enum Type
+		      {
 		        NONE, MIN, MAX, SP, MAT
-		      };
+		    ///\brief DIMACS file type enum
 		    ///
 		    ///DIMACS file type enum.
 		    enum Type {
 		      NONE,  ///< Undefined type.
 		      MIN,   ///< DIMACS file type for minimum cost flow problems.
 		      MAX,   ///< DIMACS file type for maximum flow problems.
 		      SP,    ///< DIMACS file type for shostest path problems.
 		      MAT    ///< DIMACS file type for plain graphs and matching problems.
 		    };
 		    ///The file type
 		    Type type;
 		    ///The number of nodes in the graph
 		    int nodeNum;
 		    ///The number of edges in the graph
 		    int edgeNum;
 		    int lineShift;
-		    /// Constructor. Sets the type to NONE.
+		    ///Constructor. It sets the type to \c NONE.
 		    DimacsDescriptor() : type(NONE) {}
 		  };
 		  ///Discover the type of a DIMACS file
 		  ///It starts seeking the beginning of the file for the problem type
 		  ///and size info. The found data is returned in a special struct
 		  ///that can be evaluated and passed to the appropriate reader
 		  ///function.
 		  ///This function starts seeking the beginning of the given file for the
 		  ///problem type and size info.
 		  ///The found data is returned in a special struct that can be evaluated
 		  ///and passed to the appropriate reader function.
 		  DimacsDescriptor dimacsType(std::istream& is)
+		  {
 		    DimacsDescriptor r;
 		    std::string problem,str;
 		    char c;
 		    r.lineShift=0;
 		    while (is >> c)
 		      switch(c)
+		        {
 		        case 'p':
 		          if(is >> problem >> r.nodeNum >> r.edgeNum)
+		            {
 		              getline(is, str);
 		              r.lineShift++;
 		              if(problem=="min") r.type=DimacsDescriptor::MIN;
 		              else if(problem=="max") r.type=DimacsDescriptor::MAX;
 		              else if(problem=="sp") r.type=DimacsDescriptor::SP;
 		              else if(problem=="mat") r.type=DimacsDescriptor::MAT;
 		              else throw FormatError("Unknown problem type");
 		              return r;
+		            }
 		          else
+		            {
 		              throw FormatError("Missing or wrong problem type declaration.");
+		            }
 		          break;
 		        case 'c':
 		          getline(is, str);
 		          r.lineShift++;
 		          break;
 		        default:
 		          throw FormatError("Unknown DIMACS declaration.");
+		        }
 		    throw FormatError("Missing problem type declaration.");
+		  }
 		  /// DIMACS minimum cost flow reader function.
 		  /// \brief DIMACS minimum cost flow reader function.
 		  ///
 		  /// This function reads a minimum cost flow instance from DIMACS format,
 		  /// i.e. from a DIMACS file having a line starting with
 		  /// \code
 		  ///   p min
 		  /// \endcode
 		  /// At the beginning, \c g is cleared by \c g.clear(). The supply
 		  /// amount of the nodes are written to the \c supply node map
 		  /// (they are signed values). The lower bounds, capacities and costs
 		  /// of the arcs are written to the \c lower, \c capacity and \c cost
 		  /// arc maps.
 		  ///
 		  /// If the capacity of an arc is less than the lower bound, it will
 		  /// be set to "infinite" instead. The actual value of "infinite" is
 		  /// contolled by the \c infty parameter. If it is 0 (the default value),
 		  /// \c std::numeric_limits<Capacity>::infinity() will be used if available,
 		  /// \c std::numeric_limits<Capacity>::max() otherwise. If \c infty is set to
 		  /// a non-zero value, that value will be used as "infinite".
 		  ///
 		  /// If the file type was previously evaluated by dimacsType(), then
 		  /// the descriptor struct should be given by the \c dest parameter.
 		  template <typename Digraph, typename LowerMap,
 		            typename CapacityMap, typename CostMap,
 		            typename SupplyMap>
 		  void readDimacsMin(std::istream& is,
 		                     Digraph &g,
 		                     LowerMap& lower,
 		                     CapacityMap& capacity,
 		                     CostMap& cost,
 		                     SupplyMap& supply,
 		                     typename CapacityMap::Value infty = 0,
 		                     DimacsDescriptor desc=DimacsDescriptor())
+		  {
 		    g.clear();
 		    std::vector<typename Digraph::Node> nodes;
 		    typename Digraph::Arc e;
 		    std::string problem, str;
 		    char c;
 		    int i, j;
 		    if(desc.type==DimacsDescriptor::NONE) desc=dimacsType(is);
 		    if(desc.type!=DimacsDescriptor::MIN)
 		      throw FormatError("Problem type mismatch");
 		    nodes.resize(desc.nodeNum + 1);
 		    for (int k = 1; k <= desc.nodeNum; ++k) {
 		      nodes[k] = g.addNode();
 		      supply.set(nodes[k], 0);
+		    }
@@ -208,207 +212,207 @@
 		      infty = std::numeric_limits<Capacity>::has_infinity ?
 		        std::numeric_limits<Capacity>::infinity() :
 		        std::numeric_limits<Capacity>::max();
 		    while (is >> c) {
 		      switch (c) {
 		      case 'c': // comment line
 		        getline(is, str);
 		        break;
 		      case 'n': // node definition line
 		        if (desc.type==DimacsDescriptor::SP) { // shortest path problem
 		          is >> i;
 		          getline(is, str);
 		          s = nodes[i];
+		        }
 		        if (desc.type==DimacsDescriptor::MAX) { // max flow problem
 		          is >> i >> d;
 		          getline(is, str);
 		          if (d == 's') s = nodes[i];
 		          if (d == 't') t = nodes[i];
+		        }
 		        break;
 		      case 'a': // arc definition line
 		        if (desc.type==DimacsDescriptor::SP) {
 		          is >> i >> j >> _cap;
 		          getline(is, str);
 		          e = g.addArc(nodes[i], nodes[j]);
 		          capacity.set(e, _cap);
+		        }
 		        else if (desc.type==DimacsDescriptor::MAX) {
 		          is >> i >> j >> _cap;
 		          getline(is, str);
 		          e = g.addArc(nodes[i], nodes[j]);
 		          if (_cap >= 0)
 		            capacity.set(e, _cap);
 		          else
 		            capacity.set(e, infty);
+		        }
 		        else {
 		          is >> i >> j;
 		          getline(is, str);
 		          g.addArc(nodes[i], nodes[j]);
+		        }
 		        break;
+		      }
+		    }
+		  }
 		  /// DIMACS maximum flow reader function.
+		  /// \brief DIMACS maximum flow reader function.
 		  ///
 		  /// This function reads a maximum flow instance from DIMACS format,
 		  /// i.e. from a DIMACS file having a line starting with
 		  /// \code
 		  ///   p max
 		  /// \endcode
 		  /// At the beginning, \c g is cleared by \c g.clear(). The arc
 		  /// capacities are written to the \c capacity arc map and \c s and
 		  /// \c t are set to the source and the target nodes.
 		  ///
 		  /// If the capacity of an arc is negative, it will
 		  /// be set to "infinite" instead. The actual value of "infinite" is
 		  /// contolled by the \c infty parameter. If it is 0 (the default value),
 		  /// \c std::numeric_limits<Capacity>::infinity() will be used if available,
 		  /// \c std::numeric_limits<Capacity>::max() otherwise. If \c infty is set to
 		  /// a non-zero value, that value will be used as "infinite".
 		  ///
 		  /// If the file type was previously evaluated by dimacsType(), then
 		  /// the descriptor struct should be given by the \c dest parameter.
 		  template<typename Digraph, typename CapacityMap>
 		  void readDimacsMax(std::istream& is,
 		                     Digraph &g,
 		                     CapacityMap& capacity,
 		                     typename Digraph::Node &s,
 		                     typename Digraph::Node &t,
 		                     typename CapacityMap::Value infty = 0,
 		                     DimacsDescriptor desc=DimacsDescriptor()) {
 		    if(desc.type==DimacsDescriptor::NONE) desc=dimacsType(is);
 		    if(desc.type!=DimacsDescriptor::MAX)
 		      throw FormatError("Problem type mismatch");
 		    _readDimacs(is,g,capacity,s,t,infty,desc);
+		  }
 		  /// DIMACS shortest path reader function.
+		  /// \brief DIMACS shortest path reader function.
 		  ///
 		  /// This function reads a shortest path instance from DIMACS format,
 		  /// i.e. from a DIMACS file having a line starting with
 		  /// \code
 		  ///   p sp
 		  /// \endcode
 		  /// At the beginning, \c g is cleared by \c g.clear(). The arc
 		  /// lengths are written to the \c length arc map and \c s is set to the
 		  /// source node.
 		  ///
 		  /// If the file type was previously evaluated by dimacsType(), then
 		  /// the descriptor struct should be given by the \c dest parameter.
 		  template<typename Digraph, typename LengthMap>
 		  void readDimacsSp(std::istream& is,
 		                    Digraph &g,
 		                    LengthMap& length,
 		                    typename Digraph::Node &s,
 		                    DimacsDescriptor desc=DimacsDescriptor()) {
 		    typename Digraph::Node t;
 		    if(desc.type==DimacsDescriptor::NONE) desc=dimacsType(is);
 		    if(desc.type!=DimacsDescriptor::SP)
 		      throw FormatError("Problem type mismatch");
 		    _readDimacs(is, g, length, s, t, 0, desc);
+		  }
 		  /// DIMACS capacitated digraph reader function.
+		  /// \brief DIMACS capacitated digraph reader function.
 		  ///
 		  /// This function reads an arc capacitated digraph instance from
 		  /// DIMACS 'max' or 'sp' format.
 		  /// At the beginning, \c g is cleared by \c g.clear()
 		  /// and the arc capacities/lengths are written to the \c capacity
 		  /// arc map.
 		  ///
 		  /// In case of the 'max' format, if the capacity of an arc is negative,
 		  /// it will
 		  /// be set to "infinite" instead. The actual value of "infinite" is
 		  /// contolled by the \c infty parameter. If it is 0 (the default value),
 		  /// \c std::numeric_limits<Capacity>::infinity() will be used if available,
 		  /// \c std::numeric_limits<Capacity>::max() otherwise. If \c infty is set to
 		  /// a non-zero value, that value will be used as "infinite".
 		  ///
 		  /// If the file type was previously evaluated by dimacsType(), then
 		  /// the descriptor struct should be given by the \c dest parameter.
 		  template<typename Digraph, typename CapacityMap>
 		  void readDimacsCap(std::istream& is,
 		                     Digraph &g,
 		                     CapacityMap& capacity,
 		                     typename CapacityMap::Value infty = 0,
 		                     DimacsDescriptor desc=DimacsDescriptor()) {
 		    typename Digraph::Node u,v;
 		    if(desc.type==DimacsDescriptor::NONE) desc=dimacsType(is);
 		    if(desc.type!=DimacsDescriptor::MAX || desc.type!=DimacsDescriptor::SP)
 		      throw FormatError("Problem type mismatch");
 		    _readDimacs(is, g, capacity, u, v, infty, desc);
+		  }
 		  template<typename Graph>
 		  typename enable_if<lemon::UndirectedTagIndicator<Graph>,void>::type
 		  _addArcEdge(Graph &g, typename Graph::Node s, typename Graph::Node t,
 		              dummy<0> = 0)
+		  {
 		    g.addEdge(s,t);
+		  }
 		  template<typename Graph>
 		  typename disable_if<lemon::UndirectedTagIndicator<Graph>,void>::type
 		  _addArcEdge(Graph &g, typename Graph::Node s, typename Graph::Node t,
 		              dummy<1> = 1)
+		  {
 		    g.addArc(s,t);
+		  }
 		  /// DIMACS plain (di)graph reader function.
+		  /// \brief DIMACS plain (di)graph reader function.
 		  ///
 		  /// This function reads a (di)graph without any designated nodes and
 		  /// maps from DIMACS format, i.e. from DIMACS files having a line
-		  /// starting with
+		  /// This function reads a plain (di)graph without any designated nodes
 		  /// and maps (e.g. a matching instance) from DIMACS format, i.e. from
 		  /// DIMACS files having a line starting with
 		  /// \code
 		  ///   p mat
 		  /// \endcode
 		  /// At the beginning, \c g is cleared by \c g.clear().
 		  ///
 		  /// If the file type was previously evaluated by dimacsType(), then
 		  /// the descriptor struct should be given by the \c dest parameter.
 		  template<typename Graph>
 		  void readDimacsMat(std::istream& is, Graph &g,
 		                     DimacsDescriptor desc=DimacsDescriptor())
+		  {
 		    if(desc.type==DimacsDescriptor::NONE) desc=dimacsType(is);
 		    if(desc.type!=DimacsDescriptor::MAT)
 		      throw FormatError("Problem type mismatch");
 		    g.clear();
 		    std::vector<typename Graph::Node> nodes;
 		    char c;
 		    int i, j;
 		    std::string str;
 		    nodes.resize(desc.nodeNum + 1);
 		    for (int k = 1; k <= desc.nodeNum; ++k) {
 		      nodes[k] = g.addNode();
+		    }
 		    while (is >> c) {
 		      switch (c) {
 		      case 'c': // comment line
 		        getline(is, str);
 		        break;
 		      case 'n': // node definition line
 		        break;
 		      case 'a': // arc definition line
 		        is >> i >> j;
 		        getline(is, str);
 		        _addArcEdge(g,nodes[i], nodes[j]);
 		        break;
+		      }
+		    }
+		  }
 		  /// DIMACS plain digraph writer function.
 		  ///
 		  /// This function writes a digraph without any designated nodes and
 		  /// maps into DIMACS format, i.e. into DIMACS file having a line
 		  /// starting with
 		  /// \code
 		  ///   p mat

lemon/graph_to_eps.h

Show inline comments

@@ -223,112 +223,108 @@
 		  using T::NodeTextColorType;
 		  using T::CUST_COL;
 		  using T::DIST_COL;
 		  using T::DIST_BW;
 		  using T::_nodeTextColorType;
 		  using T::_nodeTextColors;
 		  using T::_autoNodeScale;
 		  using T::_autoArcWidthScale;
 		  using T::_absoluteNodeSizes;
 		  using T::_absoluteArcWidths;
 		  using T::_negY;
 		  using T::_preScale;
 		  // dradnats ++C eht yb deriuqer si ti eveileb t'naC
 		  typedef typename T::Graph Graph;
 		  typedef typename Graph::Node Node;
 		  typedef typename Graph::NodeIt NodeIt;
 		  typedef typename Graph::Arc Arc;
 		  typedef typename Graph::ArcIt ArcIt;
 		  typedef typename Graph::InArcIt InArcIt;
 		  typedef typename Graph::OutArcIt OutArcIt;
 		  static const int INTERPOL_PREC;
 		  static const double A4HEIGHT;
 		  static const double A4WIDTH;
 		  static const double A4BORDER;
 		  bool dontPrint;
 		public:
 		  ///Node shapes
 		  ///Node shapes.
 		  ///
 		  enum NodeShapes {
 		    /// = 0
 		    ///\image html nodeshape_0.png
 		    ///\image latex nodeshape_0.eps "CIRCLE shape (0)" width=2cm
 		    CIRCLE=0,
 		    /// = 1
 		    ///\image html nodeshape_1.png
 		    ///\image latex nodeshape_1.eps "SQUARE shape (1)" width=2cm
 		    ///
 		    SQUARE=1,
 		    /// = 2
 		    ///\image html nodeshape_2.png
 		    ///\image latex nodeshape_2.eps "DIAMOND shape (2)" width=2cm
 		    ///
 		    DIAMOND=2,
 		    /// = 3
 		    ///\image html nodeshape_3.png
 		    ///\image latex nodeshape_2.eps "MALE shape (4)" width=2cm
 		    ///
 		    ///\image latex nodeshape_3.eps "MALE shape (3)" width=2cm
 		    MALE=3,
 		    /// = 4
 		    ///\image html nodeshape_4.png
 		    ///\image latex nodeshape_2.eps "FEMALE shape (4)" width=2cm
 		    ///
 		    ///\image latex nodeshape_4.eps "FEMALE shape (4)" width=2cm
 		    FEMALE=4
 		  };
 		private:
 		  class arcLess {
 		    const Graph &g;
 		  public:
 		    arcLess(const Graph &_g) : g(_g) {}
 		    bool operator()(Arc a,Arc b) const
+		    {
 		      Node ai=std::min(g.source(a),g.target(a));
 		      Node aa=std::max(g.source(a),g.target(a));
 		      Node bi=std::min(g.source(b),g.target(b));
 		      Node ba=std::max(g.source(b),g.target(b));
 		      return ai<bi ||
 		        (ai==bi && (aa < ba ||
 		                    (aa==ba && ai==g.source(a) && bi==g.target(b))));
+		    }
 		  };
 		  bool isParallel(Arc e,Arc f) const
+		  {
 		    return (g.source(e)==g.source(f)&&
 		            g.target(e)==g.target(f)) ||
 		      (g.source(e)==g.target(f)&&
 		       g.target(e)==g.source(f));
+		  }
 		  template<class TT>
 		  static std::string psOut(const dim2::Point<TT> &p)
+		    {
 		      std::ostringstream os;
 		      os << p.x << ' ' << p.y;
 		      return os.str();
+		    }
 		  static std::string psOut(const Color &c)
+		    {
 		      std::ostringstream os;
 		      os << c.red() << ' ' << c.green() << ' ' << c.blue();
 		      return os.str();
+		    }
 		public:
 		  GraphToEps(const T &t) : T(t), dontPrint(false) {};
 		  template<class X> struct CoordsTraits : public T {
 		  typedef X CoordsMapType;
 		    const X &_coords;
 		    CoordsTraits(const T &t,const X &x) : T(t), _coords(x) {}
 		  };

lemon/kruskal.h

Show inline comments

@@ -203,127 +203,125 @@
 		          seq.push_back(std::make_pair(it, in[it]));
+		        }
 		        std::sort(seq.begin(), seq.end(), PairComp<Sequence>());
 		        return KruskalOutputSelector<Graph, Sequence, Out>::
 		          kruskal(graph, seq, out);
+		      }
 		    };
 		    template <typename T>
 		    struct RemoveConst {
 		      typedef T type;
 		    };
 		    template <typename T>
 		    struct RemoveConst<const T> {
 		      typedef T type;
 		    };
 		    template <typename Graph, typename In, typename Out>
 		    struct KruskalOutputSelector<Graph, In, Out,
 		      typename enable_if<SequenceOutputIndicator<Out>, void>::type >
+		    {
 		      typedef typename In::value_type::second_type Value;
 		      static Value kruskal(const Graph& graph, const In& in, Out& out) {
 		        typedef LoggerBoolMap<typename RemoveConst<Out>::type> Map;
 		        Map map(out);
 		        return _kruskal_bits::kruskal(graph, in, map);
+		      }
 		    };
 		    template <typename Graph, typename In, typename Out>
 		    struct KruskalOutputSelector<Graph, In, Out,
 		      typename enable_if<MapOutputIndicator<Out>, void>::type >
+		    {
 		      typedef typename In::value_type::second_type Value;
 		      static Value kruskal(const Graph& graph, const In& in, Out& out) {
 		        return _kruskal_bits::kruskal(graph, in, out);
+		      }
 		    };
+		  }
 		  /// \ingroup spantree
 		  ///
-		  /// \brief Kruskal algorithm to find a minimum cost spanning tree of
+		  /// \brief Kruskal's algorithm for finding a minimum cost spanning tree of
 		  /// a graph.
 		  ///
 		  /// This function runs Kruskal's algorithm to find a minimum cost
 		  /// spanning tree.
+		  /// spanning tree of a graph.
 		  /// Due to some C++ hacking, it accepts various input and output types.
 		  ///
 		  /// \param g The graph the algorithm runs on.
 		  /// It can be either \ref concepts::Digraph "directed" or
 		  /// \ref concepts::Graph "undirected".
 		  /// If the graph is directed, the algorithm consider it to be
 		  /// undirected by disregarding the direction of the arcs.
 		  ///
 		  /// \param in This object is used to describe the arc/edge costs.
 		  /// It can be one of the following choices.
 		  /// - An STL compatible 'Forward Container' with
 		  /// <tt>std::pair<GR::Arc,X></tt> or
 		  /// <tt>std::pair<GR::Edge,X></tt> as its <tt>value_type</tt>, where
-		  /// \c X is the type of the costs. The pairs indicates the arcs/edges
+		  /// <tt>std::pair<GR::Arc,C></tt> or
 		  /// <tt>std::pair<GR::Edge,C></tt> as its <tt>value_type</tt>, where
 		  /// \c C is the type of the costs. The pairs indicates the arcs/edges
 		  /// along with the assigned cost. <em>They must be in a
 		  /// cost-ascending order.</em>
 		  /// - Any readable arc/edge map. The values of the map indicate the
 		  /// arc/edge costs.
 		  ///
 		  /// \retval out Here we also have a choice.
 		  /// - It can be a writable \c bool arc/edge map. After running the
 		  /// algorithm it will contain the found minimum cost spanning
 		  /// - It can be a writable arc/edge map with \c bool value type. After
 		  /// running the algorithm it will contain the found minimum cost spanning
 		  /// tree: the value of an arc/edge will be set to \c true if it belongs
 		  /// to the tree, otherwise it will be set to \c false. The value of
 		  /// each arc/edge will be set exactly once.
 		  /// - It can also be an iteraror of an STL Container with
 		  /// <tt>GR::Arc</tt> or <tt>GR::Edge</tt> as its
 		  /// <tt>value_type</tt>.  The algorithm copies the elements of the
 		  /// found tree into this sequence.  For example, if we know that the
 		  /// spanning tree of the graph \c g has say 53 arcs, then we can
 		  /// put its arcs into an STL vector \c tree with a code like this.
 		  ///\code
 		  /// std::vector<Arc> tree(53);
 		  /// kruskal(g,cost,tree.begin());
 		  ///\endcode
 		  /// Or if we don't know in advance the size of the tree, we can
 		  /// write this.
 		  ///\code
 		  /// std::vector<Arc> tree;
 		  /// kruskal(g,cost,std::back_inserter(tree));
 		  ///\endcode
 		  ///
 		  /// \return The total cost of the found spanning tree.
 		  ///
 		  /// \note If the input graph is not (weakly) connected, a spanning
 		  /// forest is calculated instead of a spanning tree.
 		#ifdef DOXYGEN
 		  template <class Graph, class In, class Out>
 		  Value kruskal(GR const& g, const In& in, Out& out)
 		  template <typename Graph, typename In, typename Out>
 		  Value kruskal(const Graph& g, const In& in, Out& out)
 		#else
 		  template <class Graph, class In, class Out>
 		  inline typename _kruskal_bits::KruskalValueSelector<In>::Value
 		  kruskal(const Graph& graph, const In& in, Out& out)
 		#endif
+		  {
 		    return _kruskal_bits::KruskalInputSelector<Graph, In, Out>::
 		      kruskal(graph, in, out);
+		  }
 		  template <class Graph, class In, class Out>
 		  inline typename _kruskal_bits::KruskalValueSelector<In>::Value
 		  kruskal(const Graph& graph, const In& in, const Out& out)
+		  {
 		    return _kruskal_bits::KruskalInputSelector<Graph, In, const Out>::
 		      kruskal(graph, in, out);
+		  }
 		} //namespace lemon
 		#endif //LEMON_KRUSKAL_H

lemon/lgf_reader.h

Show inline comments

@@ -548,97 +548,97 @@
+		      }
 		      for (typename Attributes::iterator it = _attributes.begin();
 		           it != _attributes.end(); ++it) {
 		        delete it->second;
+		      }
 		      if (local_is) {
 		        delete _is;
+		      }
+		    }
 		  private:
 		    template <typename DGR>
 		    friend DigraphReader<DGR> digraphReader(DGR& digraph, std::istream& is);
 		    template <typename DGR>
 		    friend DigraphReader<DGR> digraphReader(DGR& digraph,
 		                                            const std::string& fn);
 		    template <typename DGR>
 		    friend DigraphReader<DGR> digraphReader(DGR& digraph, const char *fn);
 		    DigraphReader(DigraphReader& other)
 		      : _is(other._is), local_is(other.local_is), _digraph(other._digraph),
 		        _use_nodes(other._use_nodes), _use_arcs(other._use_arcs),
 		        _skip_nodes(other._skip_nodes), _skip_arcs(other._skip_arcs) {
 		      other._is = 0;
 		      other.local_is = false;
 		      _node_index.swap(other._node_index);
 		      _arc_index.swap(other._arc_index);
 		      _node_maps.swap(other._node_maps);
 		      _arc_maps.swap(other._arc_maps);
 		      _attributes.swap(other._attributes);
 		      _nodes_caption = other._nodes_caption;
 		      _arcs_caption = other._arcs_caption;
 		      _attributes_caption = other._attributes_caption;
+		    }
 		    DigraphReader& operator=(const DigraphReader&);
 		  public:
-		    /// \name Reading rules
+		    /// \name Reading Rules
 		    /// @{
 		    /// \brief Node map reading rule
 		    ///
 		    /// Add a node map reading rule to the reader.
 		    template <typename Map>
 		    DigraphReader& nodeMap(const std::string& caption, Map& map) {
 		      checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
 		      _reader_bits::MapStorageBase<Node>* storage =
 		        new _reader_bits::MapStorage<Node, Map>(map);
 		      _node_maps.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Node map reading rule
 		    ///
 		    /// Add a node map reading rule with specialized converter to the
 		    /// reader.
 		    template <typename Map, typename Converter>
 		    DigraphReader& nodeMap(const std::string& caption, Map& map,
 		                           const Converter& converter = Converter()) {
 		      checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
 		      _reader_bits::MapStorageBase<Node>* storage =
 		        new _reader_bits::MapStorage<Node, Map, Converter>(map, converter);
 		      _node_maps.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Arc map reading rule
 		    ///
 		    /// Add an arc map reading rule to the reader.
 		    template <typename Map>
 		    DigraphReader& arcMap(const std::string& caption, Map& map) {
 		      checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
 		      _reader_bits::MapStorageBase<Arc>* storage =
 		        new _reader_bits::MapStorage<Arc, Map>(map);
 		      _arc_maps.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Arc map reading rule
 		    ///
 		    /// Add an arc map reading rule with specialized converter to the
 		    /// reader.
 		    template <typename Map, typename Converter>
 		    DigraphReader& arcMap(const std::string& caption, Map& map,
 		                          const Converter& converter = Converter()) {
 		      checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
@@ -653,126 +653,126 @@
 		    /// Add an attribute reading rule to the reader.
 		    template <typename Value>
 		    DigraphReader& attribute(const std::string& caption, Value& value) {
 		      _reader_bits::ValueStorageBase* storage =
 		        new _reader_bits::ValueStorage<Value>(value);
 		      _attributes.insert(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Attribute reading rule
 		    ///
 		    /// Add an attribute reading rule with specialized converter to the
 		    /// reader.
 		    template <typename Value, typename Converter>
 		    DigraphReader& attribute(const std::string& caption, Value& value,
 		                             const Converter& converter = Converter()) {
 		      _reader_bits::ValueStorageBase* storage =
 		        new _reader_bits::ValueStorage<Value, Converter>(value, converter);
 		      _attributes.insert(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Node reading rule
 		    ///
 		    /// Add a node reading rule to reader.
 		    DigraphReader& node(const std::string& caption, Node& node) {
 		      typedef _reader_bits::MapLookUpConverter<Node> Converter;
 		      Converter converter(_node_index);
 		      _reader_bits::ValueStorageBase* storage =
 		        new _reader_bits::ValueStorage<Node, Converter>(node, converter);
 		      _attributes.insert(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Arc reading rule
 		    ///
 		    /// Add an arc reading rule to reader.
 		    DigraphReader& arc(const std::string& caption, Arc& arc) {
 		      typedef _reader_bits::MapLookUpConverter<Arc> Converter;
 		      Converter converter(_arc_index);
 		      _reader_bits::ValueStorageBase* storage =
 		        new _reader_bits::ValueStorage<Arc, Converter>(arc, converter);
 		      _attributes.insert(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// @}
-		    /// \name Select section by name
+		    /// \name Select Section by Name
 		    /// @{
 		    /// \brief Set \c \@nodes section to be read
 		    ///
 		    /// Set \c \@nodes section to be read
 		    DigraphReader& nodes(const std::string& caption) {
 		      _nodes_caption = caption;
 		      return *this;
+		    }
 		    /// \brief Set \c \@arcs section to be read
 		    ///
 		    /// Set \c \@arcs section to be read
 		    DigraphReader& arcs(const std::string& caption) {
 		      _arcs_caption = caption;
 		      return *this;
+		    }
 		    /// \brief Set \c \@attributes section to be read
 		    ///
 		    /// Set \c \@attributes section to be read
 		    DigraphReader& attributes(const std::string& caption) {
 		      _attributes_caption = caption;
 		      return *this;
+		    }
 		    /// @}
-		    /// \name Using previously constructed node or arc set
+		    /// \name Using Previously Constructed Node or Arc Set
 		    /// @{
 		    /// \brief Use previously constructed node set
 		    ///
 		    /// Use previously constructed node set, and specify the node
 		    /// label map.
 		    template <typename Map>
 		    DigraphReader& useNodes(const Map& map) {
 		      checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
 		      LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
 		      _use_nodes = true;
 		      _writer_bits::DefaultConverter<typename Map::Value> converter;
 		      for (NodeIt n(_digraph); n != INVALID; ++n) {
 		        _node_index.insert(std::make_pair(converter(map[n]), n));
+		      }
 		      return *this;
+		    }
 		    /// \brief Use previously constructed node set
 		    ///
 		    /// Use previously constructed node set, and specify the node
 		    /// label map and a functor which converts the label map values to
 		    /// \c std::string.
 		    template <typename Map, typename Converter>
 		    DigraphReader& useNodes(const Map& map,
 		                            const Converter& converter = Converter()) {
 		      checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
 		      LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
 		      _use_nodes = true;
 		      for (NodeIt n(_digraph); n != INVALID; ++n) {
 		        _node_index.insert(std::make_pair(converter(map[n]), n));
+		      }
 		      return *this;
+		    }
 		    /// \brief Use previously constructed arc set
 		    ///
 		    /// Use previously constructed arc set, and specify the arc
 		    /// label map.
 		    template <typename Map>
 		    DigraphReader& useArcs(const Map& map) {
 		      checkConcept<concepts::ReadMap<Arc, typename Map::Value>, Map>();
 		      LEMON_ASSERT(!_use_arcs, "Multiple usage of useArcs() member");
 		      _use_arcs = true;
 		      _writer_bits::DefaultConverter<typename Map::Value> converter;
 		      for (ArcIt a(_digraph); a != INVALID; ++a) {
 		        _arc_index.insert(std::make_pair(converter(map[a]), a));
+		      }
@@ -1071,97 +1071,97 @@
 		      std::set<std::string> read_attr;
 		      char c;
 		      while (readLine() && line >> c && c != '@') {
 		        line.putback(c);
 		        std::string attr, token;
 		        if (!_reader_bits::readToken(line, attr))
 		          throw FormatError("Attribute name not found");
 		        if (!_reader_bits::readToken(line, token))
 		          throw FormatError("Attribute value not found");
 		        if (line >> c)
 		          throw FormatError("Extra character at the end of line");
+		        {
 		          std::set<std::string>::iterator it = read_attr.find(attr);
 		          if (it != read_attr.end()) {
 		            std::ostringstream msg;
 		            msg << "Multiple occurence of attribute: " << attr;
 		            throw FormatError(msg.str());
+		          }
 		          read_attr.insert(attr);
+		        }
+		        {
 		          typename Attributes::iterator it = _attributes.lower_bound(attr);
 		          while (it != _attributes.end() && it->first == attr) {
 		            it->second->set(token);
 		            ++it;
+		          }
+		        }
+		      }
 		      if (readSuccess()) {
 		        line.putback(c);
+		      }
 		      for (typename Attributes::iterator it = _attributes.begin();
 		           it != _attributes.end(); ++it) {
 		        if (read_attr.find(it->first) == read_attr.end()) {
 		          std::ostringstream msg;
 		          msg << "Attribute not found: " << it->first;
 		          throw FormatError(msg.str());
+		        }
+		      }
+		    }
 		  public:
-		    /// \name Execution of the reader
+		    /// \name Execution of the Reader
 		    /// @{
 		    /// \brief Start the batch processing
 		    ///
 		    /// This function starts the batch processing
 		    void run() {
 		      LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
 		      bool nodes_done = _skip_nodes;
 		      bool arcs_done = _skip_arcs;
 		      bool attributes_done = false;
 		      line_num = 0;
 		      readLine();
 		      skipSection();
 		      while (readSuccess()) {
 		        try {
 		          char c;
 		          std::string section, caption;
 		          line >> c;
 		          _reader_bits::readToken(line, section);
 		          _reader_bits::readToken(line, caption);
 		          if (line >> c)
 		            throw FormatError("Extra character at the end of line");
 		          if (section == "nodes" && !nodes_done) {
 		            if (_nodes_caption.empty() || _nodes_caption == caption) {
 		              readNodes();
 		              nodes_done = true;
+		            }
 		          } else if ((section == "arcs" || section == "edges") &&
 		                     !arcs_done) {
 		            if (_arcs_caption.empty() || _arcs_caption == caption) {
 		              readArcs();
 		              arcs_done = true;
+		            }
 		          } else if (section == "attributes" && !attributes_done) {
 		            if (_attributes_caption.empty() || _attributes_caption == caption) {
 		              readAttributes();
 		              attributes_done = true;
+		            }
 		          } else {
 		            readLine();
 		            skipSection();
+		          }
 		        } catch (FormatError& error) {
@@ -1344,97 +1344,97 @@
 		           it != _edge_maps.end(); ++it) {
 		        delete it->second;
+		      }
 		      for (typename Attributes::iterator it = _attributes.begin();
 		           it != _attributes.end(); ++it) {
 		        delete it->second;
+		      }
 		      if (local_is) {
 		        delete _is;
+		      }
+		    }
 		  private:
 		    template <typename Graph>
 		    friend GraphReader<Graph> graphReader(Graph& graph, std::istream& is);
 		    template <typename Graph>
 		    friend GraphReader<Graph> graphReader(Graph& graph, const std::string& fn);
 		    template <typename Graph>
 		    friend GraphReader<Graph> graphReader(Graph& graph, const char *fn);
 		    GraphReader(GraphReader& other)
 		      : _is(other._is), local_is(other.local_is), _graph(other._graph),
 		        _use_nodes(other._use_nodes), _use_edges(other._use_edges),
 		        _skip_nodes(other._skip_nodes), _skip_edges(other._skip_edges) {
 		      other._is = 0;
 		      other.local_is = false;
 		      _node_index.swap(other._node_index);
 		      _edge_index.swap(other._edge_index);
 		      _node_maps.swap(other._node_maps);
 		      _edge_maps.swap(other._edge_maps);
 		      _attributes.swap(other._attributes);
 		      _nodes_caption = other._nodes_caption;
 		      _edges_caption = other._edges_caption;
 		      _attributes_caption = other._attributes_caption;
+		    }
 		    GraphReader& operator=(const GraphReader&);
 		  public:
-		    /// \name Reading rules
+		    /// \name Reading Rules
 		    /// @{
 		    /// \brief Node map reading rule
 		    ///
 		    /// Add a node map reading rule to the reader.
 		    template <typename Map>
 		    GraphReader& nodeMap(const std::string& caption, Map& map) {
 		      checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
 		      _reader_bits::MapStorageBase<Node>* storage =
 		        new _reader_bits::MapStorage<Node, Map>(map);
 		      _node_maps.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Node map reading rule
 		    ///
 		    /// Add a node map reading rule with specialized converter to the
 		    /// reader.
 		    template <typename Map, typename Converter>
 		    GraphReader& nodeMap(const std::string& caption, Map& map,
 		                           const Converter& converter = Converter()) {
 		      checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
 		      _reader_bits::MapStorageBase<Node>* storage =
 		        new _reader_bits::MapStorage<Node, Map, Converter>(map, converter);
 		      _node_maps.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Edge map reading rule
 		    ///
 		    /// Add an edge map reading rule to the reader.
 		    template <typename Map>
 		    GraphReader& edgeMap(const std::string& caption, Map& map) {
 		      checkConcept<concepts::WriteMap<Edge, typename Map::Value>, Map>();
 		      _reader_bits::MapStorageBase<Edge>* storage =
 		        new _reader_bits::MapStorage<Edge, Map>(map);
 		      _edge_maps.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Edge map reading rule
 		    ///
 		    /// Add an edge map reading rule with specialized converter to the
 		    /// reader.
 		    template <typename Map, typename Converter>
 		    GraphReader& edgeMap(const std::string& caption, Map& map,
 		                          const Converter& converter = Converter()) {
 		      checkConcept<concepts::WriteMap<Edge, typename Map::Value>, Map>();
@@ -1495,126 +1495,126 @@
 		    /// reader.
 		    template <typename Value, typename Converter>
 		    GraphReader& attribute(const std::string& caption, Value& value,
 		                             const Converter& converter = Converter()) {
 		      _reader_bits::ValueStorageBase* storage =
 		        new _reader_bits::ValueStorage<Value, Converter>(value, converter);
 		      _attributes.insert(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Node reading rule
 		    ///
 		    /// Add a node reading rule to reader.
 		    GraphReader& node(const std::string& caption, Node& node) {
 		      typedef _reader_bits::MapLookUpConverter<Node> Converter;
 		      Converter converter(_node_index);
 		      _reader_bits::ValueStorageBase* storage =
 		        new _reader_bits::ValueStorage<Node, Converter>(node, converter);
 		      _attributes.insert(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Edge reading rule
 		    ///
 		    /// Add an edge reading rule to reader.
 		    GraphReader& edge(const std::string& caption, Edge& edge) {
 		      typedef _reader_bits::MapLookUpConverter<Edge> Converter;
 		      Converter converter(_edge_index);
 		      _reader_bits::ValueStorageBase* storage =
 		        new _reader_bits::ValueStorage<Edge, Converter>(edge, converter);
 		      _attributes.insert(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Arc reading rule
 		    ///
 		    /// Add an arc reading rule to reader.
 		    GraphReader& arc(const std::string& caption, Arc& arc) {
 		      typedef _reader_bits::GraphArcLookUpConverter<Graph> Converter;
 		      Converter converter(_graph, _edge_index);
 		      _reader_bits::ValueStorageBase* storage =
 		        new _reader_bits::ValueStorage<Arc, Converter>(arc, converter);
 		      _attributes.insert(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// @}
-		    /// \name Select section by name
+		    /// \name Select Section by Name
 		    /// @{
 		    /// \brief Set \c \@nodes section to be read
 		    ///
 		    /// Set \c \@nodes section to be read.
 		    GraphReader& nodes(const std::string& caption) {
 		      _nodes_caption = caption;
 		      return *this;
+		    }
 		    /// \brief Set \c \@edges section to be read
 		    ///
 		    /// Set \c \@edges section to be read.
 		    GraphReader& edges(const std::string& caption) {
 		      _edges_caption = caption;
 		      return *this;
+		    }
 		    /// \brief Set \c \@attributes section to be read
 		    ///
 		    /// Set \c \@attributes section to be read.
 		    GraphReader& attributes(const std::string& caption) {
 		      _attributes_caption = caption;
 		      return *this;
+		    }
 		    /// @}
-		    /// \name Using previously constructed node or edge set
+		    /// \name Using Previously Constructed Node or Edge Set
 		    /// @{
 		    /// \brief Use previously constructed node set
 		    ///
 		    /// Use previously constructed node set, and specify the node
 		    /// label map.
 		    template <typename Map>
 		    GraphReader& useNodes(const Map& map) {
 		      checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
 		      LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
 		      _use_nodes = true;
 		      _writer_bits::DefaultConverter<typename Map::Value> converter;
 		      for (NodeIt n(_graph); n != INVALID; ++n) {
 		        _node_index.insert(std::make_pair(converter(map[n]), n));
+		      }
 		      return *this;
+		    }
 		    /// \brief Use previously constructed node set
 		    ///
 		    /// Use previously constructed node set, and specify the node
 		    /// label map and a functor which converts the label map values to
 		    /// \c std::string.
 		    template <typename Map, typename Converter>
 		    GraphReader& useNodes(const Map& map,
 		                            const Converter& converter = Converter()) {
 		      checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
 		      LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
 		      _use_nodes = true;
 		      for (NodeIt n(_graph); n != INVALID; ++n) {
 		        _node_index.insert(std::make_pair(converter(map[n]), n));
+		      }
 		      return *this;
+		    }
 		    /// \brief Use previously constructed edge set
 		    ///
 		    /// Use previously constructed edge set, and specify the edge
 		    /// label map.
 		    template <typename Map>
 		    GraphReader& useEdges(const Map& map) {
 		      checkConcept<concepts::ReadMap<Edge, typename Map::Value>, Map>();
 		      LEMON_ASSERT(!_use_edges, "Multiple usage of useEdges() member");
 		      _use_edges = true;
 		      _writer_bits::DefaultConverter<typename Map::Value> converter;
 		      for (EdgeIt a(_graph); a != INVALID; ++a) {
 		        _edge_index.insert(std::make_pair(converter(map[a]), a));
+		      }
@@ -1914,97 +1914,97 @@
 		      std::set<std::string> read_attr;
 		      char c;
 		      while (readLine() && line >> c && c != '@') {
 		        line.putback(c);
 		        std::string attr, token;
 		        if (!_reader_bits::readToken(line, attr))
 		          throw FormatError("Attribute name not found");
 		        if (!_reader_bits::readToken(line, token))
 		          throw FormatError("Attribute value not found");
 		        if (line >> c)
 		          throw FormatError("Extra character at the end of line");
+		        {
 		          std::set<std::string>::iterator it = read_attr.find(attr);
 		          if (it != read_attr.end()) {
 		            std::ostringstream msg;
 		            msg << "Multiple occurence of attribute: " << attr;
 		            throw FormatError(msg.str());
+		          }
 		          read_attr.insert(attr);
+		        }
+		        {
 		          typename Attributes::iterator it = _attributes.lower_bound(attr);
 		          while (it != _attributes.end() && it->first == attr) {
 		            it->second->set(token);
 		            ++it;
+		          }
+		        }
+		      }
 		      if (readSuccess()) {
 		        line.putback(c);
+		      }
 		      for (typename Attributes::iterator it = _attributes.begin();
 		           it != _attributes.end(); ++it) {
 		        if (read_attr.find(it->first) == read_attr.end()) {
 		          std::ostringstream msg;
 		          msg << "Attribute not found: " << it->first;
 		          throw FormatError(msg.str());
+		        }
+		      }
+		    }
 		  public:
-		    /// \name Execution of the reader
+		    /// \name Execution of the Reader
 		    /// @{
 		    /// \brief Start the batch processing
 		    ///
 		    /// This function starts the batch processing
 		    void run() {
 		      LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
 		      bool nodes_done = _skip_nodes;
 		      bool edges_done = _skip_edges;
 		      bool attributes_done = false;
 		      line_num = 0;
 		      readLine();
 		      skipSection();
 		      while (readSuccess()) {
 		        try {
 		          char c;
 		          std::string section, caption;
 		          line >> c;
 		          _reader_bits::readToken(line, section);
 		          _reader_bits::readToken(line, caption);
 		          if (line >> c)
 		            throw FormatError("Extra character at the end of line");
 		          if (section == "nodes" && !nodes_done) {
 		            if (_nodes_caption.empty() || _nodes_caption == caption) {
 		              readNodes();
 		              nodes_done = true;
+		            }
 		          } else if ((section == "edges" || section == "arcs") &&
 		                     !edges_done) {
 		            if (_edges_caption.empty() || _edges_caption == caption) {
 		              readEdges();
 		              edges_done = true;
+		            }
 		          } else if (section == "attributes" && !attributes_done) {
 		            if (_attributes_caption.empty() || _attributes_caption == caption) {
 		              readAttributes();
 		              attributes_done = true;
+		            }
 		          } else {
 		            readLine();
 		            skipSection();
+		          }
@@ -2113,97 +2113,97 @@
 		        throw IoError("Cannot open file", fn);
+		      }
+		    }
 		    /// \brief Constructor
 		    ///
 		    /// Construct a section reader, which reads from the given file.
 		    SectionReader(const char* fn)
 		      : _is(new std::ifstream(fn)), local_is(true),
 		        _filename(fn) {
 		      if (!(*_is)) {
 		        delete _is;
 		        throw IoError("Cannot open file", fn);
+		      }
+		    }
 		    /// \brief Destructor
 		    ~SectionReader() {
 		      for (Sections::iterator it = _sections.begin();
 		           it != _sections.end(); ++it) {
 		        delete it->second;
+		      }
 		      if (local_is) {
 		        delete _is;
+		      }
+		    }
 		  private:
 		    friend SectionReader sectionReader(std::istream& is);
 		    friend SectionReader sectionReader(const std::string& fn);
 		    friend SectionReader sectionReader(const char* fn);
 		    SectionReader(SectionReader& other)
 		      : _is(other._is), local_is(other.local_is) {
 		      other._is = 0;
 		      other.local_is = false;
 		      _sections.swap(other._sections);
+		    }
 		    SectionReader& operator=(const SectionReader&);
 		  public:
-		    /// \name Section readers
+		    /// \name Section Readers
 		    /// @{
 		    /// \brief Add a section processor with line oriented reading
 		    ///
 		    /// The first parameter is the type descriptor of the section, the
 		    /// second is a functor, which takes just one \c std::string
 		    /// parameter. At the reading process, each line of the section
 		    /// will be given to the functor object. However, the empty lines
 		    /// and the comment lines are filtered out, and the leading
 		    /// whitespaces are trimmed from each processed string.
 		    ///
 		    /// For example let's see a section, which contain several
 		    /// integers, which should be inserted into a vector.
 		    ///\code
 		    ///  @numbers
 		    ///  12 45 23
 		    ///  4
 		    ///  23 6
 		    ///\endcode
 		    ///
 		    /// The functor is implemented as a struct:
 		    ///\code
 		    ///  struct NumberSection {
 		    ///    std::vector<int>& _data;
 		    ///    NumberSection(std::vector<int>& data) : _data(data) {}
 		    ///    void operator()(const std::string& line) {
 		    ///      std::istringstream ls(line);
 		    ///      int value;
 		    ///      while (ls >> value) _data.push_back(value);
 		    ///    }
 		    ///  };
 		    ///
 		    ///  // ...
 		    ///
 		    ///  reader.sectionLines("numbers", NumberSection(vec));
 		    ///\endcode
 		    template <typename Functor>
 		    SectionReader& sectionLines(const std::string& type, Functor functor) {
 		      LEMON_ASSERT(!type.empty(), "Type is empty.");
 		      LEMON_ASSERT(_sections.find(type) == _sections.end(),
 		                   "Multiple reading of section.");
 		      _sections.insert(std::make_pair(type,
 		        new _reader_bits::LineSection<Functor>(functor)));
 		      return *this;
+		    }
 		    /// \brief Add a section processor with stream oriented reading
@@ -2212,97 +2212,97 @@
 		    /// a functor, which takes an \c std::istream& and an \c int&
 		    /// parameter, the latter regard to the line number of stream. The
 		    /// functor can read the input while the section go on, and the
 		    /// line number should be modified accordingly.
 		    template <typename Functor>
 		    SectionReader& sectionStream(const std::string& type, Functor functor) {
 		      LEMON_ASSERT(!type.empty(), "Type is empty.");
 		      LEMON_ASSERT(_sections.find(type) == _sections.end(),
 		                   "Multiple reading of section.");
 		      _sections.insert(std::make_pair(type,
 		         new _reader_bits::StreamSection<Functor>(functor)));
 		      return *this;
+		    }
 		    /// @}
 		  private:
 		    bool readLine() {
 		      std::string str;
 		      while(++line_num, std::getline(*_is, str)) {
 		        line.clear(); line.str(str);
 		        char c;
 		        if (line >> std::ws >> c && c != '#') {
 		          line.putback(c);
 		          return true;
+		        }
+		      }
 		      return false;
+		    }
 		    bool readSuccess() {
 		      return static_cast<bool>(*_is);
+		    }
 		    void skipSection() {
 		      char c;
 		      while (readSuccess() && line >> c && c != '@') {
 		        readLine();
+		      }
 		      if (readSuccess()) {
 		        line.putback(c);
+		      }
+		    }
 		  public:
-		    /// \name Execution of the reader
+		    /// \name Execution of the Reader
 		    /// @{
 		    /// \brief Start the batch processing
 		    ///
 		    /// This function starts the batch processing.
 		    void run() {
 		      LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
 		      std::set<std::string> extra_sections;
 		      line_num = 0;
 		      readLine();
 		      skipSection();
 		      while (readSuccess()) {
 		        try {
 		          char c;
 		          std::string section, caption;
 		          line >> c;
 		          _reader_bits::readToken(line, section);
 		          _reader_bits::readToken(line, caption);
 		          if (line >> c)
 		            throw FormatError("Extra character at the end of line");
 		          if (extra_sections.find(section) != extra_sections.end()) {
 		            std::ostringstream msg;
 		            msg << "Multiple occurence of section: " << section;
 		            throw FormatError(msg.str());
+		          }
 		          Sections::iterator it = _sections.find(section);
 		          if (it != _sections.end()) {
 		            extra_sections.insert(section);
 		            it->second->process(*_is, line_num);
+		          }
 		          readLine();
 		          skipSection();
 		        } catch (FormatError& error) {
 		          error.line(line_num);
 		          error.file(_filename);
 		          throw;
+		        }
+		      }
 		      for (Sections::iterator it = _sections.begin();
 		           it != _sections.end(); ++it) {
 		        if (extra_sections.find(it->first) == extra_sections.end()) {
 		          std::ostringstream os;
@@ -2394,282 +2394,282 @@
 		    std::istringstream line;
 		  public:
 		    /// \brief Constructor
 		    ///
 		    /// Construct an \e LGF contents reader, which reads from the given
 		    /// input stream.
 		    LgfContents(std::istream& is)
 		      : _is(&is), local_is(false) {}
 		    /// \brief Constructor
 		    ///
 		    /// Construct an \e LGF contents reader, which reads from the given
 		    /// file.
 		    LgfContents(const std::string& fn)
 		      : _is(new std::ifstream(fn.c_str())), local_is(true) {
 		      if (!(*_is)) {
 		        delete _is;
 		        throw IoError("Cannot open file", fn);
+		      }
+		    }
 		    /// \brief Constructor
 		    ///
 		    /// Construct an \e LGF contents reader, which reads from the given
 		    /// file.
 		    LgfContents(const char* fn)
 		      : _is(new std::ifstream(fn)), local_is(true) {
 		      if (!(*_is)) {
 		        delete _is;
 		        throw IoError("Cannot open file", fn);
+		      }
+		    }
 		    /// \brief Destructor
 		    ~LgfContents() {
 		      if (local_is) delete _is;
+		    }
 		  private:
 		    LgfContents(const LgfContents&);
 		    LgfContents& operator=(const LgfContents&);
 		  public:
-		    /// \name Node sections
+		    /// \name Node Sections
 		    /// @{
 		    /// \brief Gives back the number of node sections in the file.
 		    ///
 		    /// Gives back the number of node sections in the file.
 		    int nodeSectionNum() const {
 		      return _node_sections.size();
+		    }
 		    /// \brief Returns the node section name at the given position.
 		    ///
 		    /// Returns the node section name at the given position.
 		    const std::string& nodeSection(int i) const {
 		      return _node_sections[i];
+		    }
 		    /// \brief Gives back the node maps for the given section.
 		    ///
 		    /// Gives back the node maps for the given section.
 		    const std::vector<std::string>& nodeMapNames(int i) const {
 		      return _node_maps[i];
+		    }
 		    /// @}
-		    /// \name Arc/Edge sections
+		    /// \name Arc/Edge Sections
 		    /// @{
 		    /// \brief Gives back the number of arc/edge sections in the file.
 		    ///
 		    /// Gives back the number of arc/edge sections in the file.
 		    /// \note It is synonym of \c edgeSectionNum().
 		    int arcSectionNum() const {
 		      return _edge_sections.size();
+		    }
 		    /// \brief Returns the arc/edge section name at the given position.
 		    ///
 		    /// Returns the arc/edge section name at the given position.
 		    /// \note It is synonym of \c edgeSection().
 		    const std::string& arcSection(int i) const {
 		      return _edge_sections[i];
+		    }
 		    /// \brief Gives back the arc/edge maps for the given section.
 		    ///
 		    /// Gives back the arc/edge maps for the given section.
 		    /// \note It is synonym of \c edgeMapNames().
 		    const std::vector<std::string>& arcMapNames(int i) const {
 		      return _edge_maps[i];
+		    }
 		    /// @}
 		    /// \name Synonyms
 		    /// @{
 		    /// \brief Gives back the number of arc/edge sections in the file.
 		    ///
 		    /// Gives back the number of arc/edge sections in the file.
 		    /// \note It is synonym of \c arcSectionNum().
 		    int edgeSectionNum() const {
 		      return _edge_sections.size();
+		    }
 		    /// \brief Returns the section name at the given position.
 		    ///
 		    /// Returns the section name at the given position.
 		    /// \note It is synonym of \c arcSection().
 		    const std::string& edgeSection(int i) const {
 		      return _edge_sections[i];
+		    }
 		    /// \brief Gives back the edge maps for the given section.
 		    ///
 		    /// Gives back the edge maps for the given section.
 		    /// \note It is synonym of \c arcMapNames().
 		    const std::vector<std::string>& edgeMapNames(int i) const {
 		      return _edge_maps[i];
+		    }
 		    /// @}
-		    /// \name Attribute sections
+		    /// \name Attribute Sections
 		    /// @{
 		    /// \brief Gives back the number of attribute sections in the file.
 		    ///
 		    /// Gives back the number of attribute sections in the file.
 		    int attributeSectionNum() const {
 		      return _attribute_sections.size();
+		    }
 		    /// \brief Returns the attribute section name at the given position.
 		    ///
 		    /// Returns the attribute section name at the given position.
 		    const std::string& attributeSectionNames(int i) const {
 		      return _attribute_sections[i];
+		    }
 		    /// \brief Gives back the attributes for the given section.
 		    ///
 		    /// Gives back the attributes for the given section.
 		    const std::vector<std::string>& attributes(int i) const {
 		      return _attributes[i];
+		    }
 		    /// @}
-		    /// \name Extra sections
+		    /// \name Extra Sections
 		    /// @{
 		    /// \brief Gives back the number of extra sections in the file.
 		    ///
 		    /// Gives back the number of extra sections in the file.
 		    int extraSectionNum() const {
 		      return _extra_sections.size();
+		    }
 		    /// \brief Returns the extra section type at the given position.
 		    ///
 		    /// Returns the section type at the given position.
 		    const std::string& extraSection(int i) const {
 		      return _extra_sections[i];
+		    }
 		    /// @}
 		  private:
 		    bool readLine() {
 		      std::string str;
 		      while(++line_num, std::getline(*_is, str)) {
 		        line.clear(); line.str(str);
 		        char c;
 		        if (line >> std::ws >> c && c != '#') {
 		          line.putback(c);
 		          return true;
+		        }
+		      }
 		      return false;
+		    }
 		    bool readSuccess() {
 		      return static_cast<bool>(*_is);
+		    }
 		    void skipSection() {
 		      char c;
 		      while (readSuccess() && line >> c && c != '@') {
 		        readLine();
+		      }
 		      if (readSuccess()) {
 		        line.putback(c);
+		      }
+		    }
 		    void readMaps(std::vector<std::string>& maps) {
 		      char c;
 		      if (!readLine() || !(line >> c) || c == '@') {
 		        if (readSuccess() && line) line.putback(c);
 		        return;
+		      }
 		      line.putback(c);
 		      std::string map;
 		      while (_reader_bits::readToken(line, map)) {
 		        maps.push_back(map);
+		      }
+		    }
 		    void readAttributes(std::vector<std::string>& attrs) {
 		      readLine();
 		      char c;
 		      while (readSuccess() && line >> c && c != '@') {
 		        line.putback(c);
 		        std::string attr;
 		        _reader_bits::readToken(line, attr);
 		        attrs.push_back(attr);
 		        readLine();
+		      }
 		      line.putback(c);
+		    }
 		  public:
-		    /// \name Execution of the contents reader
+		    /// \name Execution of the Contents Reader
 		    /// @{
 		    /// \brief Starts the reading
 		    ///
 		    /// This function starts the reading.
 		    void run() {
 		      readLine();
 		      skipSection();
 		      while (readSuccess()) {
 		        char c;
 		        line >> c;
 		        std::string section, caption;
 		        _reader_bits::readToken(line, section);
 		        _reader_bits::readToken(line, caption);
 		        if (section == "nodes") {
 		          _node_sections.push_back(caption);
 		          _node_maps.push_back(std::vector<std::string>());
 		          readMaps(_node_maps.back());
 		          readLine(); skipSection();
 		        } else if (section == "arcs" || section == "edges") {
 		          _edge_sections.push_back(caption);
 		          _arc_sections.push_back(section == "arcs");
 		          _edge_maps.push_back(std::vector<std::string>());
 		          readMaps(_edge_maps.back());
 		          readLine(); skipSection();
 		        } else if (section == "attributes") {
 		          _attribute_sections.push_back(caption);
 		          _attributes.push_back(std::vector<std::string>());
 		          readAttributes(_attributes.back());
 		        } else {
 		          _extra_sections.push_back(section);
 		          readLine(); skipSection();
+		        }
+		      }
+		    }
 		    /// @}
 		  };
+		}
 		#endif

lemon/lgf_writer.h

Show inline comments

@@ -493,97 +493,97 @@
 		        delete it->second;
+		      }
 		      for (typename Attributes::iterator it = _attributes.begin();
 		           it != _attributes.end(); ++it) {
 		        delete it->second;
+		      }
 		      if (local_os) {
 		        delete _os;
+		      }
+		    }
 		  private:
 		    template <typename DGR>
 		    friend DigraphWriter<DGR> digraphWriter(const DGR& digraph,
 		                                            std::ostream& os);
 		    template <typename DGR>
 		    friend DigraphWriter<DGR> digraphWriter(const DGR& digraph,
 		                                            const std::string& fn);
 		    template <typename DGR>
 		    friend DigraphWriter<DGR> digraphWriter(const DGR& digraph,
 		                                            const char *fn);
 		    DigraphWriter(DigraphWriter& other)
 		      : _os(other._os), local_os(other.local_os), _digraph(other._digraph),
 		        _skip_nodes(other._skip_nodes), _skip_arcs(other._skip_arcs) {
 		      other._os = 0;
 		      other.local_os = false;
 		      _node_index.swap(other._node_index);
 		      _arc_index.swap(other._arc_index);
 		      _node_maps.swap(other._node_maps);
 		      _arc_maps.swap(other._arc_maps);
 		      _attributes.swap(other._attributes);
 		      _nodes_caption = other._nodes_caption;
 		      _arcs_caption = other._arcs_caption;
 		      _attributes_caption = other._attributes_caption;
+		    }
 		    DigraphWriter& operator=(const DigraphWriter&);
 		  public:
-		    /// \name Writing rules
+		    /// \name Writing Rules
 		    /// @{
 		    /// \brief Node map writing rule
 		    ///
 		    /// Add a node map writing rule to the writer.
 		    template <typename Map>
 		    DigraphWriter& nodeMap(const std::string& caption, const Map& map) {
 		      checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
 		      _writer_bits::MapStorageBase<Node>* storage =
 		        new _writer_bits::MapStorage<Node, Map>(map);
 		      _node_maps.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Node map writing rule
 		    ///
 		    /// Add a node map writing rule with specialized converter to the
 		    /// writer.
 		    template <typename Map, typename Converter>
 		    DigraphWriter& nodeMap(const std::string& caption, const Map& map,
 		                           const Converter& converter = Converter()) {
 		      checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
 		      _writer_bits::MapStorageBase<Node>* storage =
 		        new _writer_bits::MapStorage<Node, Map, Converter>(map, converter);
 		      _node_maps.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Arc map writing rule
 		    ///
 		    /// Add an arc map writing rule to the writer.
 		    template <typename Map>
 		    DigraphWriter& arcMap(const std::string& caption, const Map& map) {
 		      checkConcept<concepts::ReadMap<Arc, typename Map::Value>, Map>();
 		      _writer_bits::MapStorageBase<Arc>* storage =
 		        new _writer_bits::MapStorage<Arc, Map>(map);
 		      _arc_maps.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Arc map writing rule
 		    ///
 		    /// Add an arc map writing rule with specialized converter to the
 		    /// writer.
 		    template <typename Map, typename Converter>
 		    DigraphWriter& arcMap(const std::string& caption, const Map& map,
 		                          const Converter& converter = Converter()) {
 		      checkConcept<concepts::ReadMap<Arc, typename Map::Value>, Map>();
@@ -596,124 +596,124 @@
 		    /// \brief Attribute writing rule
 		    ///
 		    /// Add an attribute writing rule to the writer.
 		    template <typename Value>
 		    DigraphWriter& attribute(const std::string& caption, const Value& value) {
 		      _writer_bits::ValueStorageBase* storage =
 		        new _writer_bits::ValueStorage<Value>(value);
 		      _attributes.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Attribute writing rule
 		    ///
 		    /// Add an attribute writing rule with specialized converter to the
 		    /// writer.
 		    template <typename Value, typename Converter>
 		    DigraphWriter& attribute(const std::string& caption, const Value& value,
 		                             const Converter& converter = Converter()) {
 		      _writer_bits::ValueStorageBase* storage =
 		        new _writer_bits::ValueStorage<Value, Converter>(value, converter);
 		      _attributes.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Node writing rule
 		    ///
 		    /// Add a node writing rule to the writer.
 		    DigraphWriter& node(const std::string& caption, const Node& node) {
 		      typedef _writer_bits::MapLookUpConverter<Node> Converter;
 		      Converter converter(_node_index);
 		      _writer_bits::ValueStorageBase* storage =
 		        new _writer_bits::ValueStorage<Node, Converter>(node, converter);
 		      _attributes.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Arc writing rule
 		    ///
 		    /// Add an arc writing rule to writer.
 		    DigraphWriter& arc(const std::string& caption, const Arc& arc) {
 		      typedef _writer_bits::MapLookUpConverter<Arc> Converter;
 		      Converter converter(_arc_index);
 		      _writer_bits::ValueStorageBase* storage =
 		        new _writer_bits::ValueStorage<Arc, Converter>(arc, converter);
 		      _attributes.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
-		    /// \name Section captions
+		    /// \name Section Captions
 		    /// @{
 		    /// \brief Add an additional caption to the \c \@nodes section
 		    ///
 		    /// Add an additional caption to the \c \@nodes section.
 		    DigraphWriter& nodes(const std::string& caption) {
 		      _nodes_caption = caption;
 		      return *this;
+		    }
 		    /// \brief Add an additional caption to the \c \@arcs section
 		    ///
 		    /// Add an additional caption to the \c \@arcs section.
 		    DigraphWriter& arcs(const std::string& caption) {
 		      _arcs_caption = caption;
 		      return *this;
+		    }
 		    /// \brief Add an additional caption to the \c \@attributes section
 		    ///
 		    /// Add an additional caption to the \c \@attributes section.
 		    DigraphWriter& attributes(const std::string& caption) {
 		      _attributes_caption = caption;
 		      return *this;
+		    }
-		    /// \name Skipping section
+		    /// \name Skipping Section
 		    /// @{
 		    /// \brief Skip writing the node set
 		    ///
 		    /// The \c \@nodes section will not be written to the stream.
 		    DigraphWriter& skipNodes() {
 		      LEMON_ASSERT(!_skip_nodes, "Multiple usage of skipNodes() member");
 		      _skip_nodes = true;
 		      return *this;
+		    }
 		    /// \brief Skip writing arc set
 		    ///
 		    /// The \c \@arcs section will not be written to the stream.
 		    DigraphWriter& skipArcs() {
 		      LEMON_ASSERT(!_skip_arcs, "Multiple usage of skipArcs() member");
 		      _skip_arcs = true;
 		      return *this;
+		    }
 		    /// @}
 		  private:
 		    void writeNodes() {
 		      _writer_bits::MapStorageBase<Node>* label = 0;
 		      for (typename NodeMaps::iterator it = _node_maps.begin();
 		           it != _node_maps.end(); ++it) {
 		        if (it->first == "label") {
 		          label = it->second;
 		          break;
+		        }
+		      }
 		      *_os << "@nodes";
 		      if (!_nodes_caption.empty()) {
 		        _writer_bits::writeToken(*_os << ' ', _nodes_caption);
+		      }
 		      *_os << std::endl;
 		      if (label == 0) {
 		        *_os << "label" << '\t';
+		      }
 		      for (typename NodeMaps::iterator it = _node_maps.begin();
 		           it != _node_maps.end(); ++it) {
 		        _writer_bits::writeToken(*_os, it->first) << '\t';
+		      }
 		      *_os << std::endl;
@@ -840,97 +840,97 @@
+		          }
 		          *_os << '\t';
+		        }
 		        *_os << std::endl;
+		      }
+		    }
 		    void createArcIndex() {
 		      _writer_bits::MapStorageBase<Arc>* label = 0;
 		      for (typename ArcMaps::iterator it = _arc_maps.begin();
 		           it != _arc_maps.end(); ++it) {
 		        if (it->first == "label") {
 		          label = it->second;
 		          break;
+		        }
+		      }
 		      if (label == 0) {
 		        for (ArcIt a(_digraph); a != INVALID; ++a) {
 		          std::ostringstream os;
 		          os << _digraph.id(a);
 		          _arc_index.insert(std::make_pair(a, os.str()));
+		        }
 		      } else {
 		        for (ArcIt a(_digraph); a != INVALID; ++a) {
 		          std::string value = label->get(a);
 		          _arc_index.insert(std::make_pair(a, value));
+		        }
+		      }
+		    }
 		    void writeAttributes() {
 		      if (_attributes.empty()) return;
 		      *_os << "@attributes";
 		      if (!_attributes_caption.empty()) {
 		        _writer_bits::writeToken(*_os << ' ', _attributes_caption);
+		      }
 		      *_os << std::endl;
 		      for (typename Attributes::iterator it = _attributes.begin();
 		           it != _attributes.end(); ++it) {
 		        _writer_bits::writeToken(*_os, it->first) << ' ';
 		        _writer_bits::writeToken(*_os, it->second->get());
 		        *_os << std::endl;
+		      }
+		    }
 		  public:
-		    /// \name Execution of the writer
+		    /// \name Execution of the Writer
 		    /// @{
 		    /// \brief Start the batch processing
 		    ///
 		    /// This function starts the batch processing.
 		    void run() {
 		      if (!_skip_nodes) {
 		        writeNodes();
 		      } else {
 		        createNodeIndex();
+		      }
 		      if (!_skip_arcs) {
 		        writeArcs();
 		      } else {
 		        createArcIndex();
+		      }
 		      writeAttributes();
+		    }
 		    /// \brief Give back the stream of the writer
 		    ///
 		    /// Give back the stream of the writer.
 		    std::ostream& ostream() {
 		      return *_os;
+		    }
 		    /// @}
 		  };
 		  /// \brief Return a \ref DigraphWriter class
 		  ///
 		  /// This function just returns a \ref DigraphWriter class.
 		  /// \relates DigraphWriter
 		  template <typename Digraph>
 		  DigraphWriter<Digraph> digraphWriter(const Digraph& digraph,
 		                                       std::ostream& os) {
 		    DigraphWriter<Digraph> tmp(digraph, os);
 		    return tmp;
+		  }
 		  /// \brief Return a \ref DigraphWriter class
 		  ///
 		  /// This function just returns a \ref DigraphWriter class.
 		  /// \relates DigraphWriter
 		  template <typename Digraph>
 		  DigraphWriter<Digraph> digraphWriter(const Digraph& digraph,
 		                                       const std::string& fn) {
 		    DigraphWriter<Digraph> tmp(digraph, fn);
@@ -1061,97 +1061,97 @@
 		        delete it->second;
+		      }
 		      for (typename Attributes::iterator it = _attributes.begin();
 		           it != _attributes.end(); ++it) {
 		        delete it->second;
+		      }
 		      if (local_os) {
 		        delete _os;
+		      }
+		    }
 		  private:
 		    template <typename Graph>
 		    friend GraphWriter<Graph> graphWriter(const Graph& graph,
 		                                          std::ostream& os);
 		    template <typename Graph>
 		    friend GraphWriter<Graph> graphWriter(const Graph& graph,
 		                                          const std::string& fn);
 		    template <typename Graph>
 		    friend GraphWriter<Graph> graphWriter(const Graph& graph,
 		                                          const char *fn);
 		    GraphWriter(GraphWriter& other)
 		      : _os(other._os), local_os(other.local_os), _graph(other._graph),
 		        _skip_nodes(other._skip_nodes), _skip_edges(other._skip_edges) {
 		      other._os = 0;
 		      other.local_os = false;
 		      _node_index.swap(other._node_index);
 		      _edge_index.swap(other._edge_index);
 		      _node_maps.swap(other._node_maps);
 		      _edge_maps.swap(other._edge_maps);
 		      _attributes.swap(other._attributes);
 		      _nodes_caption = other._nodes_caption;
 		      _edges_caption = other._edges_caption;
 		      _attributes_caption = other._attributes_caption;
+		    }
 		    GraphWriter& operator=(const GraphWriter&);
 		  public:
-		    /// \name Writing rules
+		    /// \name Writing Rules
 		    /// @{
 		    /// \brief Node map writing rule
 		    ///
 		    /// Add a node map writing rule to the writer.
 		    template <typename Map>
 		    GraphWriter& nodeMap(const std::string& caption, const Map& map) {
 		      checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
 		      _writer_bits::MapStorageBase<Node>* storage =
 		        new _writer_bits::MapStorage<Node, Map>(map);
 		      _node_maps.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Node map writing rule
 		    ///
 		    /// Add a node map writing rule with specialized converter to the
 		    /// writer.
 		    template <typename Map, typename Converter>
 		    GraphWriter& nodeMap(const std::string& caption, const Map& map,
 		                           const Converter& converter = Converter()) {
 		      checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
 		      _writer_bits::MapStorageBase<Node>* storage =
 		        new _writer_bits::MapStorage<Node, Map, Converter>(map, converter);
 		      _node_maps.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Edge map writing rule
 		    ///
 		    /// Add an edge map writing rule to the writer.
 		    template <typename Map>
 		    GraphWriter& edgeMap(const std::string& caption, const Map& map) {
 		      checkConcept<concepts::ReadMap<Edge, typename Map::Value>, Map>();
 		      _writer_bits::MapStorageBase<Edge>* storage =
 		        new _writer_bits::MapStorage<Edge, Map>(map);
 		      _edge_maps.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Edge map writing rule
 		    ///
 		    /// Add an edge map writing rule with specialized converter to the
 		    /// writer.
 		    template <typename Map, typename Converter>
 		    GraphWriter& edgeMap(const std::string& caption, const Map& map,
 		                          const Converter& converter = Converter()) {
 		      checkConcept<concepts::ReadMap<Edge, typename Map::Value>, Map>();
@@ -1210,124 +1210,124 @@
 		    ///
 		    /// Add an attribute writing rule with specialized converter to the
 		    /// writer.
 		    template <typename Value, typename Converter>
 		    GraphWriter& attribute(const std::string& caption, const Value& value,
 		                             const Converter& converter = Converter()) {
 		      _writer_bits::ValueStorageBase* storage =
 		        new _writer_bits::ValueStorage<Value, Converter>(value, converter);
 		      _attributes.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Node writing rule
 		    ///
 		    /// Add a node writing rule to the writer.
 		    GraphWriter& node(const std::string& caption, const Node& node) {
 		      typedef _writer_bits::MapLookUpConverter<Node> Converter;
 		      Converter converter(_node_index);
 		      _writer_bits::ValueStorageBase* storage =
 		        new _writer_bits::ValueStorage<Node, Converter>(node, converter);
 		      _attributes.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Edge writing rule
 		    ///
 		    /// Add an edge writing rule to writer.
 		    GraphWriter& edge(const std::string& caption, const Edge& edge) {
 		      typedef _writer_bits::MapLookUpConverter<Edge> Converter;
 		      Converter converter(_edge_index);
 		      _writer_bits::ValueStorageBase* storage =
 		        new _writer_bits::ValueStorage<Edge, Converter>(edge, converter);
 		      _attributes.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Arc writing rule
 		    ///
 		    /// Add an arc writing rule to writer.
 		    GraphWriter& arc(const std::string& caption, const Arc& arc) {
 		      typedef _writer_bits::GraphArcLookUpConverter<Graph> Converter;
 		      Converter converter(_graph, _edge_index);
 		      _writer_bits::ValueStorageBase* storage =
 		        new _writer_bits::ValueStorage<Arc, Converter>(arc, converter);
 		      _attributes.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
-		    /// \name Section captions
+		    /// \name Section Captions
 		    /// @{
 		    /// \brief Add an additional caption to the \c \@nodes section
 		    ///
 		    /// Add an additional caption to the \c \@nodes section.
 		    GraphWriter& nodes(const std::string& caption) {
 		      _nodes_caption = caption;
 		      return *this;
+		    }
 		    /// \brief Add an additional caption to the \c \@arcs section
 		    ///
 		    /// Add an additional caption to the \c \@arcs section.
 		    GraphWriter& edges(const std::string& caption) {
 		      _edges_caption = caption;
 		      return *this;
+		    }
 		    /// \brief Add an additional caption to the \c \@attributes section
 		    ///
 		    /// Add an additional caption to the \c \@attributes section.
 		    GraphWriter& attributes(const std::string& caption) {
 		      _attributes_caption = caption;
 		      return *this;
+		    }
-		    /// \name Skipping section
+		    /// \name Skipping Section
 		    /// @{
 		    /// \brief Skip writing the node set
 		    ///
 		    /// The \c \@nodes section will not be written to the stream.
 		    GraphWriter& skipNodes() {
 		      LEMON_ASSERT(!_skip_nodes, "Multiple usage of skipNodes() member");
 		      _skip_nodes = true;
 		      return *this;
+		    }
 		    /// \brief Skip writing edge set
 		    ///
 		    /// The \c \@edges section will not be written to the stream.
 		    GraphWriter& skipEdges() {
 		      LEMON_ASSERT(!_skip_edges, "Multiple usage of skipEdges() member");
 		      _skip_edges = true;
 		      return *this;
+		    }
 		    /// @}
 		  private:
 		    void writeNodes() {
 		      _writer_bits::MapStorageBase<Node>* label = 0;
 		      for (typename NodeMaps::iterator it = _node_maps.begin();
 		           it != _node_maps.end(); ++it) {
 		        if (it->first == "label") {
 		          label = it->second;
 		          break;
+		        }
+		      }
 		      *_os << "@nodes";
 		      if (!_nodes_caption.empty()) {
 		        _writer_bits::writeToken(*_os << ' ', _nodes_caption);
+		      }
 		      *_os << std::endl;
 		      if (label == 0) {
 		        *_os << "label" << '\t';
+		      }
 		      for (typename NodeMaps::iterator it = _node_maps.begin();
 		           it != _node_maps.end(); ++it) {
 		        _writer_bits::writeToken(*_os, it->first) << '\t';
+		      }
 		      *_os << std::endl;
@@ -1454,97 +1454,97 @@
+		          }
 		          *_os << '\t';
+		        }
 		        *_os << std::endl;
+		      }
+		    }
 		    void createEdgeIndex() {
 		      _writer_bits::MapStorageBase<Edge>* label = 0;
 		      for (typename EdgeMaps::iterator it = _edge_maps.begin();
 		           it != _edge_maps.end(); ++it) {
 		        if (it->first == "label") {
 		          label = it->second;
 		          break;
+		        }
+		      }
 		      if (label == 0) {
 		        for (EdgeIt e(_graph); e != INVALID; ++e) {
 		          std::ostringstream os;
 		          os << _graph.id(e);
 		          _edge_index.insert(std::make_pair(e, os.str()));
+		        }
 		      } else {
 		        for (EdgeIt e(_graph); e != INVALID; ++e) {
 		          std::string value = label->get(e);
 		          _edge_index.insert(std::make_pair(e, value));
+		        }
+		      }
+		    }
 		    void writeAttributes() {
 		      if (_attributes.empty()) return;
 		      *_os << "@attributes";
 		      if (!_attributes_caption.empty()) {
 		        _writer_bits::writeToken(*_os << ' ', _attributes_caption);
+		      }
 		      *_os << std::endl;
 		      for (typename Attributes::iterator it = _attributes.begin();
 		           it != _attributes.end(); ++it) {
 		        _writer_bits::writeToken(*_os, it->first) << ' ';
 		        _writer_bits::writeToken(*_os, it->second->get());
 		        *_os << std::endl;
+		      }
+		    }
 		  public:
-		    /// \name Execution of the writer
+		    /// \name Execution of the Writer
 		    /// @{
 		    /// \brief Start the batch processing
 		    ///
 		    /// This function starts the batch processing.
 		    void run() {
 		      if (!_skip_nodes) {
 		        writeNodes();
 		      } else {
 		        createNodeIndex();
+		      }
 		      if (!_skip_edges) {
 		        writeEdges();
 		      } else {
 		        createEdgeIndex();
+		      }
 		      writeAttributes();
+		    }
 		    /// \brief Give back the stream of the writer
 		    ///
 		    /// Give back the stream of the writer
 		    std::ostream& ostream() {
 		      return *_os;
+		    }
 		    /// @}
 		  };
 		  /// \brief Return a \ref GraphWriter class
 		  ///
 		  /// This function just returns a \ref GraphWriter class.
 		  /// \relates GraphWriter
 		  template <typename Graph>
 		  GraphWriter<Graph> graphWriter(const Graph& graph,
 		                                 std::ostream& os) {
 		    GraphWriter<Graph> tmp(graph, os);
 		    return tmp;
+		  }
 		  /// \brief Return a \ref GraphWriter class
 		  ///
 		  /// This function just returns a \ref GraphWriter class.
 		  /// \relates GraphWriter
 		  template <typename Graph>
 		  GraphWriter<Graph> graphWriter(const Graph& graph, const std::string& fn) {
 		    GraphWriter<Graph> tmp(graph, fn);
 		    return tmp;
@@ -1606,164 +1606,164 @@
 		        delete _os;
 		        throw IoError("Cannot write file", fn);
+		      }
+		    }
 		    /// \brief Constructor
 		    ///
 		    /// Construct a section writer, which writes into the given file.
 		    SectionWriter(const char* fn)
 		      : _os(new std::ofstream(fn)), local_os(true) {
 		      if (!(*_os)) {
 		        delete _os;
 		        throw IoError("Cannot write file", fn);
+		      }
+		    }
 		    /// \brief Destructor
 		    ~SectionWriter() {
 		      for (Sections::iterator it = _sections.begin();
 		           it != _sections.end(); ++it) {
 		        delete it->second;
+		      }
 		      if (local_os) {
 		        delete _os;
+		      }
+		    }
 		  private:
 		    friend SectionWriter sectionWriter(std::ostream& os);
 		    friend SectionWriter sectionWriter(const std::string& fn);
 		    friend SectionWriter sectionWriter(const char* fn);
 		    SectionWriter(SectionWriter& other)
 		      : _os(other._os), local_os(other.local_os) {
 		      other._os = 0;
 		      other.local_os = false;
 		      _sections.swap(other._sections);
+		    }
 		    SectionWriter& operator=(const SectionWriter&);
 		  public:
-		    /// \name Section writers
+		    /// \name Section Writers
 		    /// @{
 		    /// \brief Add a section writer with line oriented writing
 		    ///
 		    /// The first parameter is the type descriptor of the section, the
 		    /// second is a generator with std::string values. At the writing
 		    /// process, the returned \c std::string will be written into the
 		    /// output file until it is an empty string.
 		    ///
 		    /// For example, an integer vector is written into a section.
 		    ///\code
 		    ///  @numbers
 		    ///  12 45 23 78
 		    ///  4 28 38 28
 		    ///  23 6 16
 		    ///\endcode
 		    ///
 		    /// The generator is implemented as a struct.
 		    ///\code
 		    ///  struct NumberSection {
 		    ///    std::vector<int>::const_iterator _it, _end;
 		    ///    NumberSection(const std::vector<int>& data)
 		    ///      : _it(data.begin()), _end(data.end()) {}
 		    ///    std::string operator()() {
 		    ///      int rem_in_line = 4;
 		    ///      std::ostringstream ls;
 		    ///      while (rem_in_line > 0 && _it != _end) {
 		    ///        ls << *(_it++) << ' ';
 		    ///        --rem_in_line;
 		    ///      }
 		    ///      return ls.str();
 		    ///    }
 		    ///  };
 		    ///
 		    ///  // ...
 		    ///
 		    ///  writer.sectionLines("numbers", NumberSection(vec));
 		    ///\endcode
 		    template <typename Functor>
 		    SectionWriter& sectionLines(const std::string& type, Functor functor) {
 		      LEMON_ASSERT(!type.empty(), "Type is empty.");
 		      _sections.push_back(std::make_pair(type,
 		        new _writer_bits::LineSection<Functor>(functor)));
 		      return *this;
+		    }
 		    /// \brief Add a section writer with stream oriented writing
 		    ///
 		    /// The first parameter is the type of the section, the second is
 		    /// a functor, which takes a \c std::ostream& parameter. The
 		    /// functor writes the section to the output stream.
 		    /// \warning The last line must be closed with end-line character.
 		    template <typename Functor>
 		    SectionWriter& sectionStream(const std::string& type, Functor functor) {
 		      LEMON_ASSERT(!type.empty(), "Type is empty.");
 		      _sections.push_back(std::make_pair(type,
 		         new _writer_bits::StreamSection<Functor>(functor)));
 		      return *this;
+		    }
 		    /// @}
 		  public:
-		    /// \name Execution of the writer
+		    /// \name Execution of the Writer
 		    /// @{
 		    /// \brief Start the batch processing
 		    ///
 		    /// This function starts the batch processing.
 		    void run() {
 		      LEMON_ASSERT(_os != 0, "This writer is assigned to an other writer");
 		      for (Sections::iterator it = _sections.begin();
 		           it != _sections.end(); ++it) {
 		        (*_os) << '@' << it->first << std::endl;
 		        it->second->process(*_os);
+		      }
+		    }
 		    /// \brief Give back the stream of the writer
 		    ///
 		    /// Returns the stream of the writer
 		    std::ostream& ostream() {
 		      return *_os;
+		    }
 		    /// @}
 		  };
 		  /// \brief Return a \ref SectionWriter class
 		  ///
 		  /// This function just returns a \ref SectionWriter class.
 		  /// \relates SectionWriter
 		  inline SectionWriter sectionWriter(std::ostream& os) {
 		    SectionWriter tmp(os);
 		    return tmp;
+		  }
 		  /// \brief Return a \ref SectionWriter class
 		  ///
 		  /// This function just returns a \ref SectionWriter class.
 		  /// \relates SectionWriter
 		  inline SectionWriter sectionWriter(const std::string& fn) {
 		    SectionWriter tmp(fn);
 		    return tmp;
+		  }
 		  /// \brief Return a \ref SectionWriter class
 		  ///
 		  /// This function just returns a \ref SectionWriter class.

lemon/lp_base.h

Show inline comments

@@ -7,124 +7,124 @@
 		 * (Egervary Research Group on Combinatorial Optimization, EGRES).
+		 *
 		 * Permission to use, modify and distribute this software is granted
 		 * provided that this copyright notice appears in all copies. For
 		 * precise terms see the accompanying LICENSE file.
+		 *
 		 * This software is provided "AS IS" with no warranty of any kind,
 		 * express or implied, and with no claim as to its suitability for any
 		 * purpose.
+		 *
 		 */
 		#ifndef LEMON_LP_BASE_H
 		#define LEMON_LP_BASE_H
 		#include<iostream>
 		#include<vector>
 		#include<map>
 		#include<limits>
 		#include<lemon/math.h>
 		#include<lemon/error.h>
 		#include<lemon/assert.h>
 		#include<lemon/core.h>
 		#include<lemon/bits/solver_bits.h>
 		///\file
 		///\brief The interface of the LP solver interface.
 		///\ingroup lp_group
 		namespace lemon {
 		  ///Common base class for LP and MIP solvers
 		  ///Usually this class is not used directly, please use one of the concrete
 		  ///implementations of the solver interface.
 		  ///\ingroup lp_group
 		  class LpBase {
 		  protected:
 		    _solver_bits::VarIndex rows;
 		    _solver_bits::VarIndex cols;
 		  public:
 		    ///Possible outcomes of an LP solving procedure
 		    enum SolveExitStatus {
-		      ///This means that the problem has been successfully solved: either
+		      /// = 0. It means that the problem has been successfully solved: either
 		      ///an optimal solution has been found or infeasibility/unboundedness
 		      ///has been proved.
 		      SOLVED = 0,
 		      ///Any other case (including the case when some user specified
 		      ///limit has been exceeded)
 		      /// = 1. Any other case (including the case when some user specified
 		      ///limit has been exceeded).
 		      UNSOLVED = 1
 		    };
 		    ///Direction of the optimization
 		    enum Sense {
 		      /// Minimization
 		      MIN,
 		      /// Maximization
 		      MAX
 		    };
 		    ///Enum for \c messageLevel() parameter
 		    enum MessageLevel {
-		      /// no output (default value)
+		      /// No output (default value).
 		      MESSAGE_NOTHING,
-		      /// error messages only
+		      /// Error messages only.
 		      MESSAGE_ERROR,
-		      /// warnings
+		      /// Warnings.
 		      MESSAGE_WARNING,
-		      /// normal output
+		      /// Normal output.
 		      MESSAGE_NORMAL,
-		      /// verbose output
+		      /// Verbose output.
 		      MESSAGE_VERBOSE
 		    };
 		    ///The floating point type used by the solver
 		    typedef double Value;
 		    ///The infinity constant
 		    static const Value INF;
 		    ///The not a number constant
 		    static const Value NaN;
 		    friend class Col;
 		    friend class ColIt;
 		    friend class Row;
 		    friend class RowIt;
 		    ///Refer to a column of the LP.
 		    ///This type is used to refer to a column of the LP.
 		    ///
 		    ///Its value remains valid and correct even after the addition or erase of
 		    ///other columns.
 		    ///
 		    ///\note This class is similar to other Item types in LEMON, like
 		    ///Node and Arc types in digraph.
 		    class Col {
 		      friend class LpBase;
 		    protected:
 		      int _id;
 		      explicit Col(int id) : _id(id) {}
 		    public:
 		      typedef Value ExprValue;
 		      typedef True LpCol;
 		      /// Default constructor
 		      /// \warning The default constructor sets the Col to an
 		      /// undefined value.
 		      Col() {}
 		      /// Invalid constructor \& conversion.
 		      /// This constructor initializes the Col to be invalid.
 		      /// \sa Invalid for more details.
 		      Col(const Invalid&) : _id(-1) {}
 		      /// Equality operator
 		      /// Two \ref Col "Col"s are equal if and only if they point to
 		      /// the same LP column or both are invalid.
 		      bool operator==(Col c) const  {return _id == c._id;}
@@ -960,97 +960,97 @@
 		    virtual void _setColCoeffs(int i, ExprIterator b, ExprIterator e) = 0;
 		    virtual void _getColCoeffs(int i, InsertIterator b) const = 0;
 		    virtual void _setCoeff(int row, int col, Value value) = 0;
 		    virtual Value _getCoeff(int row, int col) const = 0;
 		    virtual void _setColLowerBound(int i, Value value) = 0;
 		    virtual Value _getColLowerBound(int i) const = 0;
 		    virtual void _setColUpperBound(int i, Value value) = 0;
 		    virtual Value _getColUpperBound(int i) const = 0;
 		    virtual void _setRowLowerBound(int i, Value value) = 0;
 		    virtual Value _getRowLowerBound(int i) const = 0;
 		    virtual void _setRowUpperBound(int i, Value value) = 0;
 		    virtual Value _getRowUpperBound(int i) const = 0;
 		    virtual void _setObjCoeffs(ExprIterator b, ExprIterator e) = 0;
 		    virtual void _getObjCoeffs(InsertIterator b) const = 0;
 		    virtual void _setObjCoeff(int i, Value obj_coef) = 0;
 		    virtual Value _getObjCoeff(int i) const = 0;
 		    virtual void _setSense(Sense) = 0;
 		    virtual Sense _getSense() const = 0;
 		    virtual void _clear() = 0;
 		    virtual const char* _solverName() const = 0;
 		    virtual void _messageLevel(MessageLevel level) = 0;
 		    //Own protected stuff
 		    //Constant component of the objective function
 		    Value obj_const_comp;
 		    LpBase() : rows(), cols(), obj_const_comp(0) {}
 		  public:
 		    /// Virtual destructor
 		    virtual ~LpBase() {}
 		    ///Gives back the name of the solver.
 		    const char* solverName() const {return _solverName();}
-		    ///\name Build up and modify the LP
+		    ///\name Build Up and Modify the LP
 		    ///@{
 		    ///Add a new empty column (i.e a new variable) to the LP
 		    Col addCol() { Col c; c._id = _addColId(_addCol()); return c;}
 		    ///\brief Adds several new columns (i.e variables) at once
 		    ///
 		    ///This magic function takes a container as its argument and fills
 		    ///its elements with new columns (i.e. variables)
 		    ///\param t can be
 		    ///- a standard STL compatible iterable container with
 		    ///\ref Col as its \c values_type like
 		    ///\code
 		    ///std::vector<LpBase::Col>
 		    ///std::list<LpBase::Col>
 		    ///\endcode
 		    ///- a standard STL compatible iterable container with
 		    ///\ref Col as its \c mapped_type like
 		    ///\code
 		    ///std::map<AnyType,LpBase::Col>
 		    ///\endcode
 		    ///- an iterable lemon \ref concepts::WriteMap "write map" like
 		    ///\code
 		    ///ListGraph::NodeMap<LpBase::Col>
 		    ///ListGraph::ArcMap<LpBase::Col>
 		    ///\endcode
 		    ///\return The number of the created column.
 		#ifdef DOXYGEN
 		    template<class T>
 		    int addColSet(T &t) { return 0;}
 		#else
 		    template<class T>
 		    typename enable_if<typename T::value_type::LpCol,int>::type
 		    addColSet(T &t,dummy<0> = 0) {
 		      int s=0;
 		      for(typename T::iterator i=t.begin();i!=t.end();++i) {*i=addCol();s++;}
 		      return s;
+		    }
 		    template<class T>
 		    typename enable_if<typename T::value_type::second_type::LpCol,
 		                       int>::type
 		    addColSet(T &t,dummy<1> = 1) {
 		      int s=0;
 		      for(typename T::iterator i=t.begin();i!=t.end();++i) {
 		        i->second=addCol();
 		        s++;
+		      }
@@ -1743,161 +1743,161 @@
 		  ///Multiply with constant
 		  ///\relates LpBase::DualExpr
 		  ///
 		  inline LpBase::DualExpr operator*(const LpBase::DualExpr &a,
 		                                    const LpBase::Value &b) {
 		    LpBase::DualExpr tmp(a);
 		    tmp*=b;
 		    return tmp;
+		  }
 		  ///Multiply with constant
 		  ///\relates LpBase::DualExpr
 		  ///
 		  inline LpBase::DualExpr operator*(const LpBase::Value &a,
 		                                    const LpBase::DualExpr &b) {
 		    LpBase::DualExpr tmp(b);
 		    tmp*=a;
 		    return tmp;
+		  }
 		  ///Divide with constant
 		  ///\relates LpBase::DualExpr
 		  ///
 		  inline LpBase::DualExpr operator/(const LpBase::DualExpr &a,
 		                                    const LpBase::Value &b) {
 		    LpBase::DualExpr tmp(a);
 		    tmp/=b;
 		    return tmp;
+		  }
 		  /// \ingroup lp_group
 		  ///
 		  /// \brief Common base class for LP solvers
 		  ///
 		  /// This class is an abstract base class for LP solvers. This class
 		  /// provides a full interface for set and modify an LP problem,
 		  /// solve it and retrieve the solution. You can use one of the
 		  /// descendants as a concrete implementation, or the \c Lp
 		  /// default LP solver. However, if you would like to handle LP
 		  /// solvers as reference or pointer in a generic way, you can use
 		  /// this class directly.
 		  class LpSolver : virtual public LpBase {
 		  public:
 		    /// The problem types for primal and dual problems
 		    enum ProblemType {
 		      ///Feasible solution hasn't been found (but may exist).
+		      /// = 0. Feasible solution hasn't been found (but may exist).
 		      UNDEFINED = 0,
 		      ///The problem has no feasible solution
+		      /// = 1. The problem has no feasible solution.
 		      INFEASIBLE = 1,
 		      ///Feasible solution found
+		      /// = 2. Feasible solution found.
 		      FEASIBLE = 2,
 		      ///Optimal solution exists and found
+		      /// = 3. Optimal solution exists and found.
 		      OPTIMAL = 3,
 		      ///The cost function is unbounded
+		      /// = 4. The cost function is unbounded.
 		      UNBOUNDED = 4
 		    };
 		    ///The basis status of variables
 		    enum VarStatus {
 		      /// The variable is in the basis
 		      BASIC,
 		      /// The variable is free, but not basic
 		      FREE,
 		      /// The variable has active lower bound
 		      LOWER,
 		      /// The variable has active upper bound
 		      UPPER,
 		      /// The variable is non-basic and fixed
 		      FIXED
 		    };
 		  protected:
 		    virtual SolveExitStatus _solve() = 0;
 		    virtual Value _getPrimal(int i) const = 0;
 		    virtual Value _getDual(int i) const = 0;
 		    virtual Value _getPrimalRay(int i) const = 0;
 		    virtual Value _getDualRay(int i) const = 0;
 		    virtual Value _getPrimalValue() const = 0;
 		    virtual VarStatus _getColStatus(int i) const = 0;
 		    virtual VarStatus _getRowStatus(int i) const = 0;
 		    virtual ProblemType _getPrimalType() const = 0;
 		    virtual ProblemType _getDualType() const = 0;
 		  public:
 		    ///Allocate a new LP problem instance
 		    virtual LpSolver* newSolver() const = 0;
 		    ///Make a copy of the LP problem
 		    virtual LpSolver* cloneSolver() const = 0;
 		    ///\name Solve the LP
 		    ///@{
 		    ///\e Solve the LP problem at hand
 		    ///
 		    ///\return The result of the optimization procedure. Possible
 		    ///values and their meanings can be found in the documentation of
 		    ///\ref SolveExitStatus.
 		    SolveExitStatus solve() { return _solve(); }
 		    ///@}
-		    ///\name Obtain the solution
+		    ///\name Obtain the Solution
 		    ///@{
 		    /// The type of the primal problem
 		    ProblemType primalType() const {
 		      return _getPrimalType();
+		    }
 		    /// The type of the dual problem
 		    ProblemType dualType() const {
 		      return _getDualType();
+		    }
 		    /// Return the primal value of the column
 		    /// Return the primal value of the column.
 		    /// \pre The problem is solved.
 		    Value primal(Col c) const { return _getPrimal(cols(id(c))); }
 		    /// Return the primal value of the expression
 		    /// Return the primal value of the expression, i.e. the dot
 		    /// product of the primal solution and the expression.
 		    /// \pre The problem is solved.
 		    Value primal(const Expr& e) const {
 		      double res = *e;
 		      for (Expr::ConstCoeffIt c(e); c != INVALID; ++c) {
 		        res += *c * primal(c);
+		      }
 		      return res;
+		    }
 		    /// Returns a component of the primal ray
 		    /// The primal ray is solution of the modified primal problem,
 		    /// where we change each finite bound to 0, and we looking for a
 		    /// negative objective value in case of minimization, and positive
 		    /// objective value for maximization. If there is such solution,
 		    /// that proofs the unsolvability of the dual problem, and if a
 		    /// feasible primal solution exists, then the unboundness of
 		    /// primal problem.
 		    ///
 		    /// \pre The problem is solved and the dual problem is infeasible.
 		    /// \note Some solvers does not provide primal ray calculation
 		    /// functions.
 		    Value primalRay(Col c) const { return _getPrimalRay(cols(id(c))); }
 		    /// Return the dual value of the row
@@ -1929,157 +1929,156 @@
 		    /// dual problem.
 		    ///
 		    /// \pre The problem is solved and the primal problem is infeasible.
 		    /// \note Some solvers does not provide dual ray calculation
 		    /// functions.
 		    Value dualRay(Row r) const { return _getDualRay(rows(id(r))); }
 		    /// Return the basis status of the column
 		    /// \see VarStatus
 		    VarStatus colStatus(Col c) const { return _getColStatus(cols(id(c))); }
 		    /// Return the basis status of the row
 		    /// \see VarStatus
 		    VarStatus rowStatus(Row r) const { return _getRowStatus(rows(id(r))); }
 		    ///The value of the objective function
 		    ///\return
 		    ///- \ref INF or -\ref INF means either infeasibility or unboundedness
 		    /// of the primal problem, depending on whether we minimize or maximize.
 		    ///- \ref NaN if no primal solution is found.
 		    ///- The (finite) objective value if an optimal solution is found.
 		    Value primal() const { return _getPrimalValue()+obj_const_comp;}
 		    ///@}
 		  protected:
 		  };
 		  /// \ingroup lp_group
 		  ///
 		  /// \brief Common base class for MIP solvers
 		  ///
 		  /// This class is an abstract base class for MIP solvers. This class
 		  /// provides a full interface for set and modify an MIP problem,
 		  /// solve it and retrieve the solution. You can use one of the
 		  /// descendants as a concrete implementation, or the \c Lp
 		  /// default MIP solver. However, if you would like to handle MIP
 		  /// solvers as reference or pointer in a generic way, you can use
 		  /// this class directly.
 		  class MipSolver : virtual public LpBase {
 		  public:
 		    /// The problem types for MIP problems
 		    enum ProblemType {
 		      ///Feasible solution hasn't been found (but may exist).
+		      /// = 0. Feasible solution hasn't been found (but may exist).
 		      UNDEFINED = 0,
 		      ///The problem has no feasible solution
+		      /// = 1. The problem has no feasible solution.
 		      INFEASIBLE = 1,
 		      ///Feasible solution found
+		      /// = 2. Feasible solution found.
 		      FEASIBLE = 2,
 		      ///Optimal solution exists and found
+		      /// = 3. Optimal solution exists and found.
 		      OPTIMAL = 3,
 		      ///The cost function is unbounded
 		      ///
-		      ///The Mip or at least the relaxed problem is unbounded
+		      /// = 4. The cost function is unbounded.
 		      ///The Mip or at least the relaxed problem is unbounded.
 		      UNBOUNDED = 4
 		    };
 		    ///Allocate a new MIP problem instance
 		    virtual MipSolver* newSolver() const = 0;
 		    ///Make a copy of the MIP problem
 		    virtual MipSolver* cloneSolver() const = 0;
 		    ///\name Solve the MIP
 		    ///@{
 		    /// Solve the MIP problem at hand
 		    ///
 		    ///\return The result of the optimization procedure. Possible
 		    ///values and their meanings can be found in the documentation of
 		    ///\ref SolveExitStatus.
 		    SolveExitStatus solve() { return _solve(); }
 		    ///@}
-		    ///\name Setting column type
+		    ///\name Set Column Type
 		    ///@{
 		    ///Possible variable (column) types (e.g. real, integer, binary etc.)
 		    enum ColTypes {
 		      ///Continuous variable (default)
+		      /// = 0. Continuous variable (default).
 		      REAL = 0,
 		      ///Integer variable
+		      /// = 1. Integer variable.
 		      INTEGER = 1
 		    };
 		    ///Sets the type of the given column to the given type
 		    ///Sets the type of the given column to the given type.
 		    ///
 		    void colType(Col c, ColTypes col_type) {
 		      _setColType(cols(id(c)),col_type);
+		    }
 		    ///Gives back the type of the column.
 		    ///Gives back the type of the column.
 		    ///
 		    ColTypes colType(Col c) const {
 		      return _getColType(cols(id(c)));
+		    }
 		    ///@}
-		    ///\name Obtain the solution
+		    ///\name Obtain the Solution
 		    ///@{
 		    /// The type of the MIP problem
 		    ProblemType type() const {
 		      return _getType();
+		    }
 		    /// Return the value of the row in the solution
 		    ///  Return the value of the row in the solution.
 		    /// \pre The problem is solved.
 		    Value sol(Col c) const { return _getSol(cols(id(c))); }
 		    /// Return the value of the expression in the solution
 		    /// Return the value of the expression in the solution, i.e. the
 		    /// dot product of the solution and the expression.
 		    /// \pre The problem is solved.
 		    Value sol(const Expr& e) const {
 		      double res = *e;
 		      for (Expr::ConstCoeffIt c(e); c != INVALID; ++c) {
 		        res += *c * sol(c);
+		      }
 		      return res;
+		    }
 		    ///The value of the objective function
 		    ///\return
 		    ///- \ref INF or -\ref INF means either infeasibility or unboundedness
 		    /// of the problem, depending on whether we minimize or maximize.
 		    ///- \ref NaN if no primal solution is found.
 		    ///- The (finite) objective value if an optimal solution is found.
 		    Value solValue() const { return _getSolValue()+obj_const_comp;}
 		    ///@}
 		  protected:
 		    virtual SolveExitStatus _solve() = 0;
 		    virtual ColTypes _getColType(int col) const = 0;
 		    virtual void _setColType(int col, ColTypes col_type) = 0;
 		    virtual ProblemType _getType() const = 0;
 		    virtual Value _getSol(int i) const = 0;
 		    virtual Value _getSolValue() const = 0;
 		  };

lemon/maps.h

Show inline comments

@@ -2683,98 +2683,98 @@
 		    /// Gives back the out-degree of a Node.
 		    int operator[](const Key& key) const {
 		      return _deg[key];
+		    }
 		  protected:
 		    typedef typename Digraph::Arc Arc;
 		    virtual void add(const Arc& arc) {
 		      ++_deg[_digraph.source(arc)];
+		    }
 		    virtual void add(const std::vector<Arc>& arcs) {
 		      for (int i = 0; i < int(arcs.size()); ++i) {
 		        ++_deg[_digraph.source(arcs[i])];
+		      }
+		    }
 		    virtual void erase(const Arc& arc) {
 		      --_deg[_digraph.source(arc)];
+		    }
 		    virtual void erase(const std::vector<Arc>& arcs) {
 		      for (int i = 0; i < int(arcs.size()); ++i) {
 		        --_deg[_digraph.source(arcs[i])];
+		      }
+		    }
 		    virtual void build() {
 		      for(typename Digraph::NodeIt it(_digraph); it != INVALID; ++it) {
 		        _deg[it] = countOutArcs(_digraph, it);
+		      }
+		    }
 		    virtual void clear() {
 		      for(typename Digraph::NodeIt it(_digraph); it != INVALID; ++it) {
 		        _deg[it] = 0;
+		      }
+		    }
 		  private:
 		    const Digraph& _digraph;
 		    AutoNodeMap _deg;
 		  };
 		  /// \brief Potential difference map
 		  ///
 		  /// PotentialMap returns the difference between the potentials of the
 		  /// source and target nodes of each arc in a digraph, i.e. it returns
 		  /// PotentialDifferenceMap returns the difference between the potentials of
 		  /// the source and target nodes of each arc in a digraph, i.e. it returns
 		  /// \code
 		  ///   potential[gr.target(arc)] - potential[gr.source(arc)].
 		  /// \endcode
 		  /// \tparam GR The digraph type.
 		  /// \tparam POT A node map storing the potentials.
 		  template <typename GR, typename POT>
 		  class PotentialDifferenceMap {
 		  public:
 		    /// Key type
 		    typedef typename GR::Arc Key;
 		    /// Value type
 		    typedef typename POT::Value Value;
 		    /// \brief Constructor
 		    ///
 		    /// Contructor of the map.
 		    explicit PotentialDifferenceMap(const GR& gr,
 		                                    const POT& potential)
 		      : _digraph(gr), _potential(potential) {}
 		    /// \brief Returns the potential difference for the given arc.
 		    ///
 		    /// Returns the potential difference for the given arc, i.e.
 		    /// \code
 		    ///   potential[gr.target(arc)] - potential[gr.source(arc)].
 		    /// \endcode
 		    Value operator[](const Key& arc) const {
 		      return _potential[_digraph.target(arc)] -
 		        _potential[_digraph.source(arc)];
+		    }
 		  private:
 		    const GR& _digraph;
 		    const POT& _potential;
 		  };
 		  /// \brief Returns a PotentialDifferenceMap.
 		  ///
 		  /// This function just returns a PotentialDifferenceMap.
 		  /// \relates PotentialDifferenceMap
 		  template <typename GR, typename POT>
 		  PotentialDifferenceMap<GR, POT>
 		  potentialDifferenceMap(const GR& gr, const POT& potential) {
 		    return PotentialDifferenceMap<GR, POT>(gr, potential);
+		  }
 		  /// @}
+		}

lemon/min_cost_arborescence.h

Show inline comments

@@ -45,100 +45,100 @@
 		    /// \brief The type of the map that stores the arc costs.
 		    ///
 		    /// The type of the map that stores the arc costs.
 		    /// It must meet the \ref concepts::ReadMap "ReadMap" concept.
 		    typedef CM CostMap;
 		    /// \brief The value type of the costs.
 		    ///
 		    /// The value type of the costs.
 		    typedef typename CostMap::Value Value;
 		    /// \brief The type of the map that stores which arcs are in the
 		    /// arborescence.
 		    ///
 		    /// The type of the map that stores which arcs are in the
 		    /// arborescence.  It must meet the \ref concepts::WriteMap
 		    /// "WriteMap" concept.  Initially it will be set to false on each
 		    /// arc. After it will set all arborescence arcs once.
 		    typedef typename Digraph::template ArcMap<bool> ArborescenceMap;
 		    /// \brief Instantiates a \c ArborescenceMap.
 		    ///
 		    /// This function instantiates a \c ArborescenceMap.
 		    /// \param digraph is the graph, to which we would like to
 		    /// calculate the \c ArborescenceMap.
 		    static ArborescenceMap *createArborescenceMap(const Digraph &digraph){
 		      return new ArborescenceMap(digraph);
+		    }
 		    /// \brief The type of the \c PredMap
 		    ///
 		    /// The type of the \c PredMap. It is a node map with an arc value type.
 		    typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
 		    /// \brief Instantiates a \c PredMap.
 		    ///
 		    /// This function instantiates a \c PredMap.
 		    /// \param digraph The digraph to which we would like to define the
 		    /// \c PredMap.
 		    static PredMap *createPredMap(const Digraph &digraph){
 		      return new PredMap(digraph);
+		    }
 		  };
 		  /// \ingroup spantree
 		  ///
-		  /// \brief %MinCostArborescence algorithm class.
+		  /// \brief Minimum Cost Arborescence algorithm class.
 		  ///
 		  /// This class provides an efficient implementation of
-		  /// %MinCostArborescence algorithm. The arborescence is a tree
+		  /// Minimum Cost Arborescence algorithm. The arborescence is a tree
 		  /// which is directed from a given source node of the digraph. One or
 		  /// more sources should be given for the algorithm and it will calculate
 		  /// the minimum cost subgraph which are union of arborescences with the
 		  /// given sources and spans all the nodes which are reachable from the
 		  /// sources. The time complexity of the algorithm is O(n<sup>2</sup>+e).
 		  ///
 		  /// The algorithm provides also an optimal dual solution, therefore
 		  /// the optimality of the solution can be checked.
 		  ///
 		  /// \param GR The digraph type the algorithm runs on. The default value
 		  /// is \ref ListDigraph.
 		  /// \param CM This read-only ArcMap determines the costs of the
 		  /// arcs. It is read once for each arc, so the map may involve in
 		  /// relatively time consuming process to compute the arc cost if
 		  /// it is necessary. The default map type is \ref
 		  /// concepts::Digraph::ArcMap "Digraph::ArcMap<int>".
 		  /// \param TR Traits class to set various data types used
 		  /// by the algorithm. The default traits class is
 		  /// \ref MinCostArborescenceDefaultTraits
 		  /// "MinCostArborescenceDefaultTraits<GR, CM>".  See \ref
 		  /// MinCostArborescenceDefaultTraits for the documentation of a
 		  /// MinCostArborescence traits class.
 		#ifndef DOXYGEN
 		  template <typename GR = ListDigraph,
 		            typename CM = typename GR::template ArcMap<int>,
 		            typename TR =
 		              MinCostArborescenceDefaultTraits<GR, CM> >
 		#else
 		  template <typename GR, typename CM, typedef TR>
 		#endif
 		  class MinCostArborescence {
 		  public:
 		    /// The traits.
 		    typedef TR Traits;
 		    /// The type of the underlying digraph.
 		    typedef typename Traits::Digraph Digraph;
 		    /// The type of the map that stores the arc costs.
 		    typedef typename Traits::CostMap CostMap;
 		    ///The type of the costs of the arcs.
 		    typedef typename Traits::Value Value;
 		    ///The type of the predecessor map.
 		    typedef typename Traits::PredMap PredMap;
 		    ///The type of the map that stores which arcs are in the arborescence.
 		    typedef typename Traits::ArborescenceMap ArborescenceMap;
 		    typedef MinCostArborescence Create;
@@ -345,97 +345,97 @@
 		        level.arcs.push_back((*_cost_arcs)[nodes[i]]);
 		        (*_cost_arcs)[nodes[i]].arc = INVALID;
+		      }
 		      level_stack.push_back(level);
 		      return minimum.arc;
+		    }
 		    int bottom(Node node) {
 		      int k = level_stack.size() - 1;
 		      while (level_stack[k].node_level > (*_node_order)[node]) {
 		        --k;
+		      }
 		      return level_stack[k].node_level;
+		    }
 		    void finalize(Arc arc) {
 		      Node node = _digraph->target(arc);
 		      _heap->push(node, (*_arc_order)[arc]);
 		      _pred->set(node, arc);
 		      while (!_heap->empty()) {
 		        Node source = _heap->top();
 		        _heap->pop();
 		        (*_node_order)[source] = -1;
 		        for (OutArcIt it(*_digraph, source); it != INVALID; ++it) {
 		          if ((*_arc_order)[it] < 0) continue;
 		          Node target = _digraph->target(it);
 		          switch(_heap->state(target)) {
 		          case Heap::PRE_HEAP:
 		            _heap->push(target, (*_arc_order)[it]);
 		            _pred->set(target, it);
 		            break;
 		          case Heap::IN_HEAP:
 		            if ((*_arc_order)[it] < (*_heap)[target]) {
 		              _heap->decrease(target, (*_arc_order)[it]);
 		              _pred->set(target, it);
+		            }
 		            break;
 		          case Heap::POST_HEAP:
 		            break;
+		          }
+		        }
 		        _arborescence->set((*_pred)[source], true);
+		      }
+		    }
 		  public:
-		    /// \name Named template parameters
+		    /// \name Named Template Parameters
 		    /// @{
 		    template <class T>
 		    struct DefArborescenceMapTraits : public Traits {
 		      typedef T ArborescenceMap;
 		      static ArborescenceMap *createArborescenceMap(const Digraph &)
+		      {
 		        LEMON_ASSERT(false, "ArborescenceMap is not initialized");
 		        return 0; // ignore warnings
+		      }
 		    };
 		    /// \brief \ref named-templ-param "Named parameter" for
 		    /// setting ArborescenceMap type
 		    ///
 		    /// \ref named-templ-param "Named parameter" for setting
 		    /// ArborescenceMap type
 		    template <class T>
 		    struct DefArborescenceMap
 		      : public MinCostArborescence<Digraph, CostMap,
 		                                   DefArborescenceMapTraits<T> > {
 		    };
 		    template <class T>
 		    struct DefPredMapTraits : public Traits {
 		      typedef T PredMap;
 		      static PredMap *createPredMap(const Digraph &)
+		      {
 		        LEMON_ASSERT(false, "PredMap is not initialized");
+		      }
 		    };
 		    /// \brief \ref named-templ-param "Named parameter" for
 		    /// setting PredMap type
 		    ///
 		    /// \ref named-templ-param "Named parameter" for setting
 		    /// PredMap type
 		    template <class T>
 		    struct DefPredMap
 		      : public MinCostArborescence<Digraph, CostMap, DefPredMapTraits<T> > {
 		    };
 		    /// @}
 		    /// \brief Constructor.
 		    ///
 		    /// \param digraph The digraph the algorithm will run on.
@@ -585,97 +585,97 @@
 		    public:
 		      /// \brief Constructor.
 		      ///
 		      /// Constructor for get the nodeset of the variable.
 		      DualIt(const MinCostArborescence& algorithm, int variable)
 		        : _algorithm(&algorithm)
+		      {
 		        _index = _algorithm->_dual_variables[variable].begin;
 		        _last = _algorithm->_dual_variables[variable].end;
+		      }
 		      /// \brief Conversion to node.
 		      ///
 		      /// Conversion to node.
 		      operator Node() const {
 		        return _algorithm->_dual_node_list[_index];
+		      }
 		      /// \brief Increment operator.
 		      ///
 		      /// Increment operator.
 		      DualIt& operator++() {
 		        ++_index;
 		        return *this;
+		      }
 		      /// \brief Validity checking
 		      ///
 		      /// Checks whether the iterator is invalid.
 		      bool operator==(Invalid) const {
 		        return _index == _last;
+		      }
 		      /// \brief Validity checking
 		      ///
 		      /// Checks whether the iterator is valid.
 		      bool operator!=(Invalid) const {
 		        return _index != _last;
+		      }
 		    private:
 		      const MinCostArborescence* _algorithm;
 		      int _index, _last;
 		    };
 		    /// @}
-		    /// \name Execution control
+		    /// \name Execution Control
 		    /// The simplest way to execute the algorithm is to use
 		    /// one of the member functions called \c run(...). \n
 		    /// If you need more control on the execution,
 		    /// first you must call \ref init(), then you can add several
 		    /// source nodes with \ref addSource().
 		    /// Finally \ref start() will perform the arborescence
 		    /// computation.
 		    ///@{
 		    /// \brief Initializes the internal data structures.
 		    ///
 		    /// Initializes the internal data structures.
 		    ///
 		    void init() {
 		      createStructures();
 		      _heap->clear();
 		      for (NodeIt it(*_digraph); it != INVALID; ++it) {
 		        (*_cost_arcs)[it].arc = INVALID;
 		        (*_node_order)[it] = -3;
 		        (*_heap_cross_ref)[it] = Heap::PRE_HEAP;
 		        _pred->set(it, INVALID);
+		      }
 		      for (ArcIt it(*_digraph); it != INVALID; ++it) {
 		        _arborescence->set(it, false);
 		        (*_arc_order)[it] = -1;
+		      }
 		      _dual_node_list.clear();
 		      _dual_variables.clear();
+		    }
 		    /// \brief Adds a new source node.
 		    ///
 		    /// Adds a new source node to the algorithm.
 		    void addSource(Node source) {
 		      std::vector<Node> nodes;
 		      nodes.push_back(source);
 		      while (!nodes.empty()) {
 		        Node node = nodes.back();
 		        nodes.pop_back();
 		        for (OutArcIt it(*_digraph, node); it != INVALID; ++it) {
 		          Node target = _digraph->target(it);
 		          if ((*_node_order)[target] == -3) {
 		            (*_node_order)[target] = -2;
 		            nodes.push_back(target);
 		            queue.push_back(target);
+		          }
+		        }

lemon/random.h

Show inline comments

@@ -614,97 +614,97 @@
 		    /// \brief Seeding from file
 		    ///
 		    /// Seeding the random sequence from file. The linux kernel has two
 		    /// devices, <tt>/dev/random</tt> and <tt>/dev/urandom</tt> which
 		    /// could give good seed values for pseudo random generators (The
 		    /// difference between two devices is that the <tt>random</tt> may
 		    /// block the reading operation while the kernel can give good
 		    /// source of randomness, while the <tt>urandom</tt> does not
 		    /// block the input, but it could give back bytes with worse
 		    /// entropy).
 		    /// \param file The source file
 		    /// \param offset The offset, from the file read.
 		    /// \return \c true when the seeding successes.
 		#ifndef WIN32
 		    bool seedFromFile(const std::string& file = "/dev/urandom", int offset = 0)
 		#else
 		    bool seedFromFile(const std::string& file = "", int offset = 0)
 		#endif
+		    {
 		      std::ifstream rs(file.c_str());
 		      const int size = 4;
 		      Word buf[size];
 		      if (offset != 0 && !rs.seekg(offset)) return false;
 		      if (!rs.read(reinterpret_cast<char*>(buf), sizeof(buf))) return false;
 		      seed(buf, buf + size);
 		      return true;
+		    }
 		    /// \brief Seding from process id and time
 		    ///
 		    /// Seding from process id and time. This function uses the
 		    /// current process id and the current time for initialize the
 		    /// random sequence.
 		    /// \return Currently always \c true.
 		    bool seedFromTime() {
 		#ifndef WIN32
 		      timeval tv;
 		      gettimeofday(&tv, 0);
 		      seed(getpid() + tv.tv_sec + tv.tv_usec);
 		#else
 		      seed(bits::getWinRndSeed());
 		#endif
 		      return true;
+		    }
 		    /// @}
-		    ///\name Uniform distributions
+		    ///\name Uniform Distributions
 		    ///
 		    /// @{
 		    /// \brief Returns a random real number from the range [0, 1)
 		    ///
 		    /// It returns a random real number from the range [0, 1). The
 		    /// default Number type is \c double.
 		    template <typename Number>
 		    Number real() {
 		      return _random_bits::RealConversion<Number, Word>::convert(core);
+		    }
 		    double real() {
 		      return real<double>();
+		    }
 		    /// \brief Returns a random real number from the range [0, 1)
 		    ///
 		    /// It returns a random double from the range [0, 1).
 		    double operator()() {
 		      return real<double>();
+		    }
 		    /// \brief Returns a random real number from the range [0, b)
 		    ///
 		    /// It returns a random real number from the range [0, b).
 		    double operator()(double b) {
 		      return real<double>() * b;
+		    }
 		    /// \brief Returns a random real number from the range [a, b)
 		    ///
 		    /// It returns a random real number from the range [a, b).
 		    double operator()(double a, double b) {
 		      return real<double>() * (b - a) + a;
+		    }
 		    /// \brief Returns a random integer from a range
 		    ///
 		    /// It returns a random integer from the range {0, 1, ..., b - 1}.
 		    template <typename Number>
 		    Number integer(Number b) {
 		      return _random_bits::Mapping<Number, Word>::map(core, b);
+		    }
 		    /// \brief Returns a random integer from a range
 		    ///
 		    /// It returns a random integer from the range {a, a + 1, ..., b - 1}.
@@ -717,97 +717,97 @@
 		    ///
 		    /// It returns a random integer from the range {0, 1, ..., b - 1}.
 		    template <typename Number>
 		    Number operator[](Number b) {
 		      return _random_bits::Mapping<Number, Word>::map(core, b);
+		    }
 		    /// \brief Returns a random non-negative integer
 		    ///
 		    /// It returns a random non-negative integer uniformly from the
 		    /// whole range of the current \c Number type. The default result
 		    /// type of this function is <tt>unsigned int</tt>.
 		    template <typename Number>
 		    Number uinteger() {
 		      return _random_bits::IntConversion<Number, Word>::convert(core);
+		    }
 		    unsigned int uinteger() {
 		      return uinteger<unsigned int>();
+		    }
 		    /// \brief Returns a random integer
 		    ///
 		    /// It returns a random integer uniformly from the whole range of
 		    /// the current \c Number type. The default result type of this
 		    /// function is \c int.
 		    template <typename Number>
 		    Number integer() {
 		      static const int nb = std::numeric_limits<Number>::digits +
 		        (std::numeric_limits<Number>::is_signed ? 1 : 0);
 		      return _random_bits::IntConversion<Number, Word, nb>::convert(core);
+		    }
 		    int integer() {
 		      return integer<int>();
+		    }
 		    /// \brief Returns a random bool
 		    ///
 		    /// It returns a random bool. The generator holds a buffer for
 		    /// random bits. Every time when it become empty the generator makes
 		    /// a new random word and fill the buffer up.
 		    bool boolean() {
 		      return bool_producer.convert(core);
+		    }
 		    /// @}
-		    ///\name Non-uniform distributions
+		    ///\name Non-uniform Distributions
 		    ///
 		    ///@{
 		    /// \brief Returns a random bool with given probability of true result.
 		    ///
 		    /// It returns a random bool with given probability of true result.
 		    bool boolean(double p) {
 		      return operator()() < p;
+		    }
 		    /// Standard normal (Gauss) distribution
 		    /// Standard normal (Gauss) distribution.
 		    /// \note The Cartesian form of the Box-Muller
 		    /// transformation is used to generate a random normal distribution.
 		    double gauss()
+		    {
 		      double V1,V2,S;
 		      do {
 		        V1=2*real<double>()-1;
 		        V2=2*real<double>()-1;
 		        S=V1*V1+V2*V2;
 		      } while(S>=1);
 		      return std::sqrt(-2*std::log(S)/S)*V1;
+		    }
 		    /// Normal (Gauss) distribution with given mean and standard deviation
 		    /// Normal (Gauss) distribution with given mean and standard deviation.
 		    /// \sa gauss()
 		    double gauss(double mean,double std_dev)
+		    {
 		      return gauss()*std_dev+mean;
+		    }
 		    /// Lognormal distribution
 		    /// Lognormal distribution. The parameters are the mean and the standard
 		    /// deviation of <tt>exp(X)</tt>.
 		    ///
 		    double lognormal(double n_mean,double n_std_dev)
+		    {
 		      return std::exp(gauss(n_mean,n_std_dev));
+		    }
 		    /// Lognormal distribution
 		    /// Lognormal distribution. The parameter is an <tt>std::pair</tt> of
 		    /// the mean and the standard deviation of <tt>exp(X)</tt>.
 		    ///
@@ -893,97 +893,97 @@
 		    /// This function generates a Weibull distribution random number.
 		    ///
 		    ///\param k shape parameter (<tt>k>0</tt>)
 		    ///\param lambda scale parameter (<tt>lambda>0</tt>)
 		    ///
 		    double weibull(double k,double lambda)
+		    {
 		      return lambda*pow(-std::log(1.0-real<double>()),1.0/k);
+		    }
 		    /// Pareto distribution
 		    /// This function generates a Pareto distribution random number.
 		    ///
 		    ///\param k shape parameter (<tt>k>0</tt>)
 		    ///\param x_min location parameter (<tt>x_min>0</tt>)
 		    ///
 		    double pareto(double k,double x_min)
+		    {
 		      return exponential(gamma(k,1.0/x_min))+x_min;
+		    }
 		    /// Poisson distribution
 		    /// This function generates a Poisson distribution random number with
 		    /// parameter \c lambda.
 		    ///
 		    /// The probability mass function of this distribusion is
 		    /// \f[ \frac{e^{-\lambda}\lambda^k}{k!} \f]
 		    /// \note The algorithm is taken from the book of Donald E. Knuth titled
 		    /// ''Seminumerical Algorithms'' (1969). Its running time is linear in the
 		    /// return value.
 		    int poisson(double lambda)
+		    {
 		      const double l = std::exp(-lambda);
 		      int k=0;
 		      double p = 1.0;
 		      do {
 		        k++;
 		        p*=real<double>();
 		      } while (p>=l);
 		      return k-1;
+		    }
 		    ///@}
-		    ///\name Two dimensional distributions
+		    ///\name Two Dimensional Distributions
 		    ///
 		    ///@{
 		    /// Uniform distribution on the full unit circle
 		    /// Uniform distribution on the full unit circle.
 		    ///
 		    dim2::Point<double> disc()
+		    {
 		      double V1,V2;
 		      do {
 		        V1=2*real<double>()-1;
 		        V2=2*real<double>()-1;
 		      } while(V1*V1+V2*V2>=1);
 		      return dim2::Point<double>(V1,V2);
+		    }
 		    /// A kind of two dimensional normal (Gauss) distribution
 		    /// This function provides a turning symmetric two-dimensional distribution.
 		    /// Both coordinates are of standard normal distribution, but they are not
 		    /// independent.
 		    ///
 		    /// \note The coordinates are the two random variables provided by
 		    /// the Box-Muller method.
 		    dim2::Point<double> gauss2()
+		    {
 		      double V1,V2,S;
 		      do {
 		        V1=2*real<double>()-1;
 		        V2=2*real<double>()-1;
 		        S=V1*V1+V2*V2;
 		      } while(S>=1);
 		      double W=std::sqrt(-2*std::log(S)/S);
 		      return dim2::Point<double>(W*V1,W*V2);
+		    }
 		    /// A kind of two dimensional exponential distribution
 		    /// This function provides a turning symmetric two-dimensional distribution.
 		    /// The x-coordinate is of conditionally exponential distribution
 		    /// with the condition that x is positive and y=0. If x is negative and
 		    /// y=0 then, -x is of exponential distribution. The same is true for the
 		    /// y-coordinate.
 		    dim2::Point<double> exponential2()
+		    {
 		      double V1,V2,S;
 		      do {
 		        V1=2*real<double>()-1;

lemon/suurballe.h

Show inline comments

@@ -243,97 +243,97 @@
 		    Suurballe( const Digraph &digraph,
 		               const LengthMap &length,
 		               Node s, Node t ) :
 		      _graph(digraph), _length(length), _flow(0), _local_flow(false),
 		      _potential(0), _local_potential(false), _source(s), _target(t),
 		      _pred(digraph) {}
 		    /// Destructor.
 		    ~Suurballe() {
 		      if (_local_flow) delete _flow;
 		      if (_local_potential) delete _potential;
 		      delete _dijkstra;
+		    }
 		    /// \brief Set the flow map.
 		    ///
 		    /// This function sets the flow map.
 		    ///
 		    /// The found flow contains only 0 and 1 values. It is the union of
 		    /// the found arc-disjoint paths.
 		    ///
 		    /// \return <tt>(*this)</tt>
 		    Suurballe& flowMap(FlowMap &map) {
 		      if (_local_flow) {
 		        delete _flow;
 		        _local_flow = false;
+		      }
 		      _flow = &map;
 		      return *this;
+		    }
 		    /// \brief Set the potential map.
 		    ///
 		    /// This function sets the potential map.
 		    ///
 		    /// The potentials provide the dual solution of the underlying
 		    /// minimum cost flow problem.
 		    ///
 		    /// \return <tt>(*this)</tt>
 		    Suurballe& potentialMap(PotentialMap &map) {
 		      if (_local_potential) {
 		        delete _potential;
 		        _local_potential = false;
+		      }
 		      _potential = &map;
 		      return *this;
+		    }
-		    /// \name Execution control
+		    /// \name Execution Control
 		    /// The simplest way to execute the algorithm is to call the run()
 		    /// function.
 		    /// \n
 		    /// If you only need the flow that is the union of the found
 		    /// arc-disjoint paths, you may call init() and findFlow().
 		    /// @{
 		    /// \brief Run the algorithm.
 		    ///
 		    /// This function runs the algorithm.
 		    ///
 		    /// \param k The number of paths to be found.
 		    ///
 		    /// \return \c k if there are at least \c k arc-disjoint paths from
 		    /// \c s to \c t in the digraph. Otherwise it returns the number of
 		    /// arc-disjoint paths found.
 		    ///
 		    /// \note Apart from the return value, <tt>s.run(k)</tt> is just a
 		    /// shortcut of the following code.
 		    /// \code
 		    ///   s.init();
 		    ///   s.findFlow(k);
 		    ///   s.findPaths();
 		    /// \endcode
 		    int run(int k = 2) {
 		      init();
 		      findFlow(k);
 		      findPaths();
 		      return _path_num;
+		    }
 		    /// \brief Initialize the algorithm.
 		    ///
 		    /// This function initializes the algorithm.
 		    void init() {
 		      // Initialize maps
 		      if (!_flow) {
 		        _flow = new FlowMap(_graph);
 		        _local_flow = true;
+		      }
 		      if (!_potential) {
 		        _potential = new PotentialMap(_graph);
 		        _local_potential = true;
+		      }
 		      for (ArcIt e(_graph); e != INVALID; ++e) (*_flow)[e] = 0;
 		      for (NodeIt n(_graph); n != INVALID; ++n) (*_potential)[n] = 0;

lemon/time_measure.h

Show inline comments

@@ -242,97 +242,97 @@
 		  ///
 		  /// int main()
 		  /// {
 		  ///
 		  ///   ...
 		  ///
 		  ///   Timer t;
 		  ///   doSomething();
 		  ///   std::cout << t << '\n';
 		  ///   t.restart();
 		  ///   doSomethingElse();
 		  ///   std::cout << t << '\n';
 		  ///
 		  ///   ...
 		  ///
 		  /// }
 		  ///\endcode
 		  ///
 		  ///The \ref Timer can also be \ref stop() "stopped" and
 		  ///\ref start() "started" again, so it is possible to compute collected
 		  ///running times.
 		  ///
 		  ///\warning Depending on the operation system and its actual configuration
 		  ///the time counters have a certain (10ms on a typical Linux system)
 		  ///granularity.
 		  ///Therefore this tool is not appropriate to measure very short times.
 		  ///Also, if you start and stop the timer very frequently, it could lead to
 		  ///distorted results.
 		  ///
 		  ///\note If you want to measure the running time of the execution of a certain
 		  ///function, consider the usage of \ref TimeReport instead.
 		  ///
 		  ///\sa TimeReport
 		  class Timer
+		  {
 		    int _running; //Timer is running iff _running>0; (_running>=0 always holds)
 		    TimeStamp start_time; //This is the relativ start-time if the timer
 		                          //is _running, the collected _running time otherwise.
 		    void _reset() {if(_running) start_time.stamp(); else start_time.reset();}
 		  public:
 		    ///Constructor.
 		    ///\param run indicates whether or not the timer starts immediately.
 		    ///
 		    Timer(bool run=true) :_running(run) {_reset();}
-		    ///\name Control the state of the timer
+		    ///\name Control the State of the Timer
 		    ///Basically a Timer can be either running or stopped,
 		    ///but it provides a bit finer control on the execution.
 		    ///The \ref lemon::Timer "Timer" also counts the number of
 		    ///\ref lemon::Timer::start() "start()" executions, and it stops
 		    ///only after the same amount (or more) \ref lemon::Timer::stop()
 		    ///"stop()"s. This can be useful e.g. to compute the running time
 		    ///of recursive functions.
 		    ///@{
 		    ///Reset and stop the time counters
 		    ///This function resets and stops the time counters
 		    ///\sa restart()
 		    void reset()
+		    {
 		      _running=0;
 		      _reset();
+		    }
 		    ///Start the time counters
 		    ///This function starts the time counters.
 		    ///
 		    ///If the timer is started more than ones, it will remain running
 		    ///until the same amount of \ref stop() is called.
 		    ///\sa stop()
 		    void start()
+		    {
 		      if(_running) _running++;
 		      else {
 		        _running=1;
 		        TimeStamp t;
 		        t.stamp();
 		        start_time=t-start_time;
+		      }
+		    }
 		    ///Stop the time counters
 		    ///This function stops the time counters. If start() was executed more than
 		    ///once, then the same number of stop() execution is necessary the really
 		    ///stop the timer.
 		    ///
 		    ///\sa halt()
 		    ///\sa start()
 		    ///\sa restart()
@@ -350,97 +350,97 @@
 		    ///Halt (i.e stop immediately) the time counters
 		    ///This function stops immediately the time counters, i.e. <tt>t.halt()</tt>
 		    ///is a faster
 		    ///equivalent of the following.
 		    ///\code
 		    ///  while(t.running()) t.stop()
 		    ///\endcode
 		    ///
 		    ///
 		    ///\sa stop()
 		    ///\sa restart()
 		    ///\sa reset()
 		    void halt()
+		    {
 		      if(_running) {
 		        _running=0;
 		        TimeStamp t;
 		        t.stamp();
 		        start_time=t-start_time;
+		      }
+		    }
 		    ///Returns the running state of the timer
 		    ///This function returns the number of stop() exections that is
 		    ///necessary to really stop the timer.
 		    ///For example the timer
 		    ///is running if and only if the return value is \c true
 		    ///(i.e. greater than
 		    ///zero).
 		    int running()  { return _running; }
 		    ///Restart the time counters
 		    ///This function is a shorthand for
 		    ///a reset() and a start() calls.
 		    ///
 		    void restart()
+		    {
 		      reset();
 		      start();
+		    }
 		    ///@}
-		    ///\name Query Functions for the ellapsed time
+		    ///\name Query Functions for the Ellapsed Time
 		    ///@{
 		    ///Gives back the ellapsed user time of the process
 		    double userTime() const
+		    {
 		      return operator TimeStamp().userTime();
+		    }
 		    ///Gives back the ellapsed system time of the process
 		    double systemTime() const
+		    {
 		      return operator TimeStamp().systemTime();
+		    }
 		    ///Gives back the ellapsed user time of the process' children
 		    ///\note On <tt>WIN32</tt> platform this value is not calculated.
 		    ///
 		    double cUserTime() const
+		    {
 		      return operator TimeStamp().cUserTime();
+		    }
 		    ///Gives back the ellapsed user time of the process' children
 		    ///\note On <tt>WIN32</tt> platform this value is not calculated.
 		    ///
 		    double cSystemTime() const
+		    {
 		      return operator TimeStamp().cSystemTime();
+		    }
 		    ///Gives back the ellapsed real time
 		    double realTime() const
+		    {
 		      return operator TimeStamp().realTime();
+		    }
 		    ///Computes the ellapsed time
 		    ///This conversion computes the ellapsed time, therefore you can print
 		    ///the ellapsed time like this.
 		    ///\code
 		    ///  Timer t;
 		    ///  doSomething();
 		    ///  std::cout << t << '\n';
 		    ///\endcode
 		    operator TimeStamp () const
+		    {
 		      TimeStamp t;
 		      t.stamp();
 		      return _running?t-start_time:start_time;

tools/dimacs-solver.cc

Show inline comments

 		/* -*- mode: C++; indent-tabs-mode: nil; -*-
+		 *
 		 * This file is a part of LEMON, a generic C++ optimization library.
+		 *
 		 * Copyright (C) 2003-2009
 		 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
 		 * (Egervary Research Group on Combinatorial Optimization, EGRES).
+		 *
 		 * Permission to use, modify and distribute this software is granted
 		 * provided that this copyright notice appears in all copies. For
 		 * precise terms see the accompanying LICENSE file.
+		 *
 		 * This software is provided "AS IS" with no warranty of any kind,
 		 * express or implied, and with no claim as to its suitability for any
 		 * purpose.
+		 *
 		 */
 		///\ingroup tools
 		///\file
 		///\brief DIMACS problem solver.
 		///
 		/// This program solves various problems given in DIMACS format.
 		///
 		/// See
 		/// \verbatim
 		///  dimacs-solver --help
-		/// \endverbatim
+		/// \code
 		///   dimacs-solver --help
 		/// \endcode
 		/// for more info on usage.
 		///
 		#include <iostream>
 		#include <fstream>
 		#include <cstring>
 		#include <lemon/smart_graph.h>
 		#include <lemon/dimacs.h>
 		#include <lemon/lgf_writer.h>
 		#include <lemon/time_measure.h>
 		#include <lemon/arg_parser.h>
 		#include <lemon/error.h>
 		#include <lemon/dijkstra.h>
 		#include <lemon/preflow.h>
 		#include <lemon/max_matching.h>
 		using namespace lemon;
 		typedef SmartDigraph Digraph;
 		DIGRAPH_TYPEDEFS(Digraph);
 		typedef SmartGraph Graph;
 		template<class Value>
 		void solve_sp(ArgParser &ap, std::istream &is, std::ostream &,
 		              DimacsDescriptor &desc)
+		{
 		  bool report = !ap.given("q");
 		  Digraph g;
 		  Node s;
 		  Digraph::ArcMap<Value> len(g);
 		  Timer t;
 		  t.restart();
 		  readDimacsSp(is, g, len, s, desc);
 		  if(report) std::cerr << "Read the file: " << t << '\n';
 		  t.restart();
 		  Dijkstra<Digraph, Digraph::ArcMap<Value> > dij(g,len);
 		  if(report) std::cerr << "Setup Dijkstra class: " << t << '\n';
 		  t.restart();
 		  dij.run(s);
 		  if(report) std::cerr << "Run Dijkstra: " << t << '\n';
+		}
 		template<class Value>
 		void solve_max(ArgParser &ap, std::istream &is, std::ostream &,
 		               Value infty, DimacsDescriptor &desc)
+		{
 		  bool report = !ap.given("q");
 		  Digraph g;

tools/dimacs-to-lgf.cc

Show inline comments

 		/* -*- mode: C++; indent-tabs-mode: nil; -*-
+		 *
 		 * This file is a part of LEMON, a generic C++ optimization library.
+		 *
 		 * Copyright (C) 2003-2009
 		 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
 		 * (Egervary Research Group on Combinatorial Optimization, EGRES).
+		 *
 		 * Permission to use, modify and distribute this software is granted
 		 * provided that this copyright notice appears in all copies. For
 		 * precise terms see the accompanying LICENSE file.
+		 *
 		 * This software is provided "AS IS" with no warranty of any kind,
 		 * express or implied, and with no claim as to its suitability for any
 		 * purpose.
+		 *
 		 */
 		///\ingroup tools
 		///\file
 		///\brief DIMACS to LGF converter.
 		///
 		/// This program converts various DIMACS formats to the LEMON Digraph Format
 		/// (LGF).
 		///
 		/// See
 		/// \verbatim
 		///  dimacs-to-lgf --help
 		/// \endverbatim
 		/// for more info on usage.
 		///
+		/// \code
 		///   dimacs-to-lgf --help
 		/// \endcode
 		/// for more info on the usage.
 		#include <iostream>
 		#include <fstream>
 		#include <cstring>
 		#include <lemon/smart_graph.h>
 		#include <lemon/dimacs.h>
 		#include <lemon/lgf_writer.h>
 		#include <lemon/arg_parser.h>
 		#include <lemon/error.h>
 		using namespace std;
 		using namespace lemon;
 		int main(int argc, const char *argv[]) {
 		  typedef SmartDigraph Digraph;
 		  typedef Digraph::Arc Arc;
 		  typedef Digraph::Node Node;
 		  typedef Digraph::ArcIt ArcIt;
 		  typedef Digraph::NodeIt NodeIt;
 		  typedef Digraph::ArcMap<double> DoubleArcMap;
 		  typedef Digraph::NodeMap<double> DoubleNodeMap;
 		  std::string inputName;
 		  std::string outputName;
 		  ArgParser ap(argc, argv);
 		  ap.other("[INFILE [OUTFILE]]",
 		           "If either the INFILE or OUTFILE file is missing the standard\n"
 		           "     input/output will be used instead.")
 		    .run();
 		  ifstream input;
 		  ofstream output;
 		  switch(ap.files().size())
+		    {
 		    case 2:
 		      output.open(ap.files()[1].c_str());
 		      if (!output) {
 		        throw IoError("Cannot open the file for writing", ap.files()[1]);
+		      }
 		    case 1:
 		      input.open(ap.files()[0].c_str());
 		      if (!input) {

tools/lgf-gen.cc

Show inline comments

 		/* -*- mode: C++; indent-tabs-mode: nil; -*-
+		 *
 		 * This file is a part of LEMON, a generic C++ optimization library.
+		 *
 		 * Copyright (C) 2003-2009
 		 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
 		 * (Egervary Research Group on Combinatorial Optimization, EGRES).
+		 *
 		 * Permission to use, modify and distribute this software is granted
 		 * provided that this copyright notice appears in all copies. For
 		 * precise terms see the accompanying LICENSE file.
+		 *
 		 * This software is provided "AS IS" with no warranty of any kind,
 		 * express or implied, and with no claim as to its suitability for any
 		 * purpose.
+		 *
 		 */
 		/// \ingroup tools
 		/// \file
 		/// \brief Special plane digraph generator.
 		///
 		/// Graph generator application for various types of plane graphs.
 		///
 		/// See
 		/// \verbatim
 		///  lgf-gen --help
-		/// \endverbatim
+		/// \code
 		///   lgf-gen --help
 		/// \endcode
 		/// for more info on the usage.
 		///
 		#include <algorithm>
 		#include <set>
 		#include <ctime>
 		#include <lemon/list_graph.h>
 		#include <lemon/random.h>
 		#include <lemon/dim2.h>
 		#include <lemon/bfs.h>
 		#include <lemon/counter.h>
 		#include <lemon/suurballe.h>
 		#include <lemon/graph_to_eps.h>
 		#include <lemon/lgf_writer.h>
 		#include <lemon/arg_parser.h>
 		#include <lemon/euler.h>
 		#include <lemon/math.h>
 		#include <lemon/kruskal.h>
 		#include <lemon/time_measure.h>
 		using namespace lemon;
 		typedef dim2::Point<double> Point;
 		GRAPH_TYPEDEFS(ListGraph);
 		bool progress=true;
 		int N;
 		// int girth;
 		ListGraph g;
 		std::vector<Node> nodes;
 		ListGraph::NodeMap<Point> coords(g);
 		double totalLen(){
 		  double tlen=0;
 		  for(EdgeIt e(g);e!=INVALID;++e)
 		    tlen+=sqrt((coords[g.v(e)]-coords[g.u(e)]).normSquare());
 		  return tlen;
+		}
 		int tsp_impr_num=0;
 		const double EPSILON=1e-8;
 		bool tsp_improve(Node u, Node v)
+		{
 		  double luv=std::sqrt((coords[v]-coords[u]).normSquare());

0 comments (0 inline)

RhodeCode

Login to your account