marci@330: // -*- c++ -*-
marci@644: #ifndef HUGO_FOR_EACH_MACROS_H
marci@644: #define HUGO_FOR_EACH_MACROS_H
marci@330: 
marci@636: // /// \ingroup gwrappers
marci@636: /// \file
marci@638: /// \brief Iteration macros.
marci@636: ///
marci@636: /// This file contains several macros which make easier writting 
marci@638: /// for cycles in HUGO using HUGO iterators.
marci@636: ///
marci@636: /// \author Marton Makai
marci@636: 
marci@330: namespace hugo {
marci@330: 
marci@638:   /// This macro provides a comfortable interface for iterating with HUGO 
marci@638:   /// iterators.
marci@638:   /// \code
marci@638:   /// Graph g;
marci@639:   /// ...
marci@638:   /// Graph::NodeIt n;
marci@654:   /// h_for_glob(n, g) {
marci@638:   /// ...
marci@638:   /// }
marci@638:   /// Graph::EdgeIt e;
marci@654:   /// h_for_glob(e, g) {
marci@638:   /// ...
marci@638:   /// }
marci@638:   /// \endcode
marci@638:   /// Note that the iterated variables \c n and \c e are global ones. 
marci@654: #define h_for_glob(e, g) for((g).first((e)); (g).valid((e)); (g).next((e)))
marci@654: 
marci@654: /// \deprecated
marci@409: #define FOR_EACH_GLOB(e, g) for((g).first((e)); (g).valid((e)); (g).next((e)))
marci@636: 
marci@638:   /// This macro provides a comfortable interface for iterating with HUGO 
marci@638:   /// iterators.
marci@638:   /// \code
marci@638:   /// Graph g;
marci@639:   /// ...
marci@638:   /// Graph::Node v;
marci@638:   /// Graph::OutEdgeIt e;
marci@654:   /// h_for_inc_glob(e, g, v) {
marci@638:   /// ...
marci@638:   /// }
marci@638:   /// typedef BipartiteGraph<Graph> BGraph;
marci@638:   /// BGraph h;
marci@639:   /// ...
marci@638:   /// BGraph::ClassNodeIt n;
marci@654:   /// h_for_inc_glob(BGraph::ClassNodeIt, n, h, h.S_CLASS) {
marci@638:   /// ...
marci@638:   /// }
marci@638:   /// \endcode
marci@638:   /// Note that iterated variables \c e and \c n are global ones. 
marci@654: #define h_for_inc_glob(e, g, v) for((g).first((e), (v)); (g).valid((e)); (g).next((e)))
marci@654: 
marci@654: /// \deprecated
marci@409: #define FOR_EACH_INC_GLOB(e, g, v) for((g).first((e), (v)); (g).valid((e)); (g).next((e)))
marci@638:   
marci@636: /// \deprecated
marci@638: //#define FOR_EACH_EDGE_GLOB(e, g) for((g).first((e)); (g).valid((e)); (g).next((e)))
marci@636: /// \deprecated
marci@638: //#define FOR_EACH_NODE_GLOB(e, g) for((g).first((e)); (g).valid((e)); (g).next((e)))
marci@636: /// \deprecated
marci@638: //#define FOR_EACH_INEDGE_GLOB(e, g, v) for((g).first((e), (v)); (g).valid((e)); (g).next((e)))
marci@636: /// \deprecated
marci@638: //#define FOR_EACH_OUTEDGE_GLOB(e, g, v) for((g).first((e), (v)); (g).valid((e)); (g).next((e)))
marci@330: 
marci@330: //   template<typename It, typename Graph> 
marci@330: //   It loopFirst(const Graph& g) const {
marci@330: //     It e; g.first(e); return e; 
marci@330: //   }
marci@330: 
marci@330: //   template<typename It, typename Graph> 
marci@330: //   It loopFirst(const Graph& g, const Node& v) const {
marci@330: //     It e; g.first(e, v); return e; 
marci@330: //   }
marci@330: 
marci@330: //   template<typename Graph> 
marci@330: //   typename Graph::NodeIt loopFirstNode(const Graph& g) const {
marci@330: //     typename Graph::NodeIt e; g.first(e); return e; 
marci@330: //   }
marci@330: //   template<typename Graph> 
marci@330: //   typename Graph::EdgeIt loopFirstEdge(const Graph& g) const {
marci@330: //     typename Graph::EdgeIt e; g.first(e); return e; 
marci@330: //   }
marci@330: //   template<typename Graph> 
marci@330: //   typename Graph::OutEdgeIt 
marci@330: //   loopFirstOutEdge(const Graph& g, const Node& n) const {
marci@330: //     typename Graph::OutEdgeIt e; g.first(e, n); return e; 
marci@330: //   }
marci@330: //   template<typename Graph> 
marci@330: //   typename Graph::InEdgeIt 
marci@330: //   loopFirstIn Edge(const Graph& g, const Node& n) const {
marci@330: //     typename Graph::InEdgeIt e; g.first(e, n); return e; 
marci@330: //   }
marci@330: 
marci@330: //FIXME ezt hogy a gorcsbe birja levezetni. Csak ugy leveszi a const-ot??
marci@330:   template<typename It, typename Graph> 
marci@333:   It loopFirst(const It&, const Graph& g) {
marci@333:     It e; g.first(e); return e; 
marci@330:   }
marci@330: 
marci@330:   template<typename It, typename Graph, typename Node> 
marci@333:   It loopFirst(const It&, const Graph& g, const Node& v) {
marci@333:     It e; g.first(e, v); return e; 
marci@330:   }
marci@330: 
marci@330: //   template<typename Graph> 
marci@330: //   typename Graph::NodeIt loopFirstNode(const Graph& g) const {
marci@330: //     typename Graph::NodeIt e; g.first(e); return e; 
marci@330: //   }
marci@330: //   template<typename Graph> 
marci@330: //   typename Graph::EdgeIt loopFirstEdge(const Graph& g) const {
marci@330: //     typename Graph::EdgeIt e; g.first(e); return e; 
marci@330: //   }
marci@330: //   template<typename Graph> 
marci@330: //   typename Graph::OutEdgeIt 
marci@330: //   loopFirstOutEdge(const Graph& g, const Node& n) const {
marci@330: //     typename Graph::OutEdgeIt e; g.first(e, n); return e; 
marci@330: //   }
marci@330: //   template<typename Graph> 
marci@330: //   typename Graph::InEdgeIt 
marci@330: //   loopFirstIn Edge(const Graph& g, const Node& n) const {
marci@330: //     typename Graph::InEdgeIt e; g.first(e, n); return e; 
marci@330: //   }
marci@330: 
marci@638:   /// This macro provides a comfortable interface for iterating with HUGO 
marci@638:   /// iterators.
marci@638:   /// \code
marci@638:   /// Graph g;
marci@639:   /// ...
marci@654:   /// h_for(Graph::NodeIt, n, g) {
marci@638:   /// ...
marci@638:   /// }
marci@654:   /// h_for(Graph::EdgeIt, e, g) {
marci@638:   /// ...
marci@638:   /// }
marci@638:   /// \endcode
marci@638:   /// Note that the iterated variables \c n and \c e are local ones. 
marci@654: #define h_for(Ittype, e, g) for(Ittype e=loopFirst(Ittype(), (g)); (g).valid(e); (g).next(e))
marci@654:   
marci@654: /// \deprecated
marci@333: #define FOR_EACH_LOC(Ittype, e, g) for(Ittype e=loopFirst(Ittype(), (g)); (g).valid(e); (g).next(e))
marci@654: 
marci@638:   /// This macro provides a comfortable interface for iterating with HUGO 
marci@638:   /// iterators.
marci@638:   /// \code
marci@638:   /// Graph g;
marci@639:   /// ...
marci@638:   /// Graph::Node v;
marci@654:   /// h_for_inc(Graph::OutEdgeIt, e, g, v) {
marci@638:   /// ...
marci@638:   /// }
marci@638:   /// typedef BipartiteGraph<Graph> BGraph;
marci@638:   /// BGraph h;
marci@639:   /// ...
marci@654:   /// h_for_inc(BGraph::ClassNodeIt, n, h, h.S_CLASS) {
marci@638:   /// ...
marci@638:   /// }
marci@638:   /// \endcode
marci@638:   /// Note that the iterated variables \c e and \c n are local ones. 
marci@654: #define h_for_inc(Ittype, e, g, v) for(Ittype e=loopFirst(Ittype(), (g), (v)); (g).valid(e); (g).next(e))
marci@654:   
marci@654: /// \deprecated
marci@333: #define FOR_EACH_INC_LOC(Ittype, e, g, v) for(Ittype e=loopFirst(Ittype(), (g), (v)); (g).valid(e); (g).next(e))
marci@638:   
marci@333: // #define FOR_EACH_EDGE_LOC(e, g) ezt nem tom hogy kell for((g).first((e)); (g).valid((e)); (g).next((e)))
marci@330: // #define FOR_EACH_NODE_LOC(e, g) for((g).first((e)); (g).valid((e)); (g).next((e)))
marci@330: // #define FOR_EACH_INEDGE_LOC(e, g, v) for((g).first((e), (v)); (g).valid((e)); (g).next((e)))
marci@330: // #define FOR_EACH_OUTEDGE_LOC(e, g, v) for((g).first((e), (v)); (g).valid((e)); (g).next((e)))
marci@330: 
marci@330: } //namespace hugo
marci@330: 
marci@644: #endif //HUGO_FOR_EACH_MACROS_H