source: lemon-0.x/src/hugo/for_each_macros.h @ 691:014c2e4eb07b

// -*- c++ -*-
#ifndef HUGO_FOR_EACH_MACROS_H
#define HUGO_FOR_EACH_MACROS_H

// /// \ingroup gwrappers
/// \file
/// \brief Iteration macros.
///
/// This file contains several macros which make easier writting 
/// for cycles in HUGO using HUGO iterators.
///
/// \author Marton Makai

namespace hugo {

  /// This macro provides a comfortable interface for iterating with HUGO 
  /// iterators.
  /// \code
  /// Graph g;
  /// ...
  /// Graph::NodeIt n;
  /// h_for_glob(n, g) {
  /// ...
  /// }
  /// Graph::EdgeIt e;
  /// h_for_glob(e, g) {
  /// ...
  /// }
  /// \endcode
  /// Note that the iterated variables \c n and \c e are global ones. 
#define h_for_glob(e, g) for((g).first((e)); (g).valid((e)); (g).next((e)))

/// \deprecated
#define FOR_EACH_GLOB(e, g) for((g).first((e)); (g).valid((e)); (g).next((e)))

  /// This macro provides a comfortable interface for iterating with HUGO 
  /// iterators.
  /// \code
  /// Graph g;
  /// ...
  /// Graph::Node v;
  /// Graph::OutEdgeIt e;
  /// h_for_inc_glob(e, g, v) {
  /// ...
  /// }
  /// typedef BipartiteGraph<Graph> BGraph;
  /// BGraph h;
  /// ...
  /// BGraph::ClassNodeIt n;
  /// h_for_inc_glob(BGraph::ClassNodeIt, n, h, h.S_CLASS) {
  /// ...
  /// }
  /// \endcode
  /// Note that iterated variables \c e and \c n are global ones. 
#define h_for_inc_glob(e, g, v) for((g).first((e), (v)); (g).valid((e)); (g).next((e)))

/// \deprecated
#define FOR_EACH_INC_GLOB(e, g, v) for((g).first((e), (v)); (g).valid((e)); (g).next((e)))
  
/// \deprecated
//#define FOR_EACH_EDGE_GLOB(e, g) for((g).first((e)); (g).valid((e)); (g).next((e)))
/// \deprecated
//#define FOR_EACH_NODE_GLOB(e, g) for((g).first((e)); (g).valid((e)); (g).next((e)))
/// \deprecated
//#define FOR_EACH_INEDGE_GLOB(e, g, v) for((g).first((e), (v)); (g).valid((e)); (g).next((e)))
/// \deprecated
//#define FOR_EACH_OUTEDGE_GLOB(e, g, v) for((g).first((e), (v)); (g).valid((e)); (g).next((e)))

//   template<typename It, typename Graph> 
//   It loopFirst(const Graph& g) const {
//     It e; g.first(e); return e; 
//   }

//   template<typename It, typename Graph> 
//   It loopFirst(const Graph& g, const Node& v) const {
//     It e; g.first(e, v); return e; 
//   }

//   template<typename Graph> 
//   typename Graph::NodeIt loopFirstNode(const Graph& g) const {
//     typename Graph::NodeIt e; g.first(e); return e; 
//   }
//   template<typename Graph> 
//   typename Graph::EdgeIt loopFirstEdge(const Graph& g) const {
//     typename Graph::EdgeIt e; g.first(e); return e; 
//   }
//   template<typename Graph> 
//   typename Graph::OutEdgeIt 
//   loopFirstOutEdge(const Graph& g, const Node& n) const {
//     typename Graph::OutEdgeIt e; g.first(e, n); return e; 
//   }
//   template<typename Graph> 
//   typename Graph::InEdgeIt 
//   loopFirstIn Edge(const Graph& g, const Node& n) const {
//     typename Graph::InEdgeIt e; g.first(e, n); return e; 
//   }

//FIXME ezt hogy a gorcsbe birja levezetni. Csak ugy leveszi a const-ot??
  template<typename It, typename Graph> 
  It loopFirst(const It&, const Graph& g) {
    It e; g.first(e); return e; 
  }

  template<typename It, typename Graph, typename Node> 
  It loopFirst(const It&, const Graph& g, const Node& v) {
    It e; g.first(e, v); return e; 
  }

//   template<typename Graph> 
//   typename Graph::NodeIt loopFirstNode(const Graph& g) const {
//     typename Graph::NodeIt e; g.first(e); return e; 
//   }
//   template<typename Graph> 
//   typename Graph::EdgeIt loopFirstEdge(const Graph& g) const {
//     typename Graph::EdgeIt e; g.first(e); return e; 
//   }
//   template<typename Graph> 
//   typename Graph::OutEdgeIt 
//   loopFirstOutEdge(const Graph& g, const Node& n) const {
//     typename Graph::OutEdgeIt e; g.first(e, n); return e; 
//   }
//   template<typename Graph> 
//   typename Graph::InEdgeIt 
//   loopFirstIn Edge(const Graph& g, const Node& n) const {
//     typename Graph::InEdgeIt e; g.first(e, n); return e; 
//   }

  /// This macro provides a comfortable interface for iterating with HUGO 
  /// iterators.
  /// \code
  /// Graph g;
  /// ...
  /// h_for(Graph::NodeIt, n, g) {
  /// ...
  /// }
  /// h_for(Graph::EdgeIt, e, g) {
  /// ...
  /// }
  /// \endcode
  /// Note that the iterated variables \c n and \c e are local ones. 
#define h_for(Ittype, e, g) for(Ittype e=loopFirst(Ittype(), (g)); (g).valid(e); (g).next(e))
  
/// \deprecated
#define FOR_EACH_LOC(Ittype, e, g) for(Ittype e=loopFirst(Ittype(), (g)); (g).valid(e); (g).next(e))

  /// This macro provides a comfortable interface for iterating with HUGO 
  /// iterators.
  /// \code
  /// Graph g;
  /// ...
  /// Graph::Node v;
  /// h_for_inc(Graph::OutEdgeIt, e, g, v) {
  /// ...
  /// }
  /// typedef BipartiteGraph<Graph> BGraph;
  /// BGraph h;
  /// ...
  /// h_for_inc(BGraph::ClassNodeIt, n, h, h.S_CLASS) {
  /// ...
  /// }
  /// \endcode
  /// Note that the iterated variables \c e and \c n are local ones. 
#define h_for_inc(Ittype, e, g, v) for(Ittype e=loopFirst(Ittype(), (g), (v)); (g).valid(e); (g).next(e))
  
/// \deprecated
#define FOR_EACH_INC_LOC(Ittype, e, g, v) for(Ittype e=loopFirst(Ittype(), (g), (v)); (g).valid(e); (g).next(e))
  
// #define FOR_EACH_EDGE_LOC(e, g) ezt nem tom hogy kell for((g).first((e)); (g).valid((e)); (g).next((e)))
// #define FOR_EACH_NODE_LOC(e, g) for((g).first((e)); (g).valid((e)); (g).next((e)))
// #define FOR_EACH_INEDGE_LOC(e, g, v) for((g).first((e), (v)); (g).valid((e)); (g).next((e)))
// #define FOR_EACH_OUTEDGE_LOC(e, g, v) for((g).first((e), (v)); (g).valid((e)); (g).next((e)))

} //namespace hugo

#endif //HUGO_FOR_EACH_MACROS_H