tpl_cut_nodes.H

Go to the documentation of this file.

/*
                          Aleph_w
 
  Data structures & Algorithms
  version 2.0.0b
  https://github.com/lrleon/Aleph-w
 
  This file is part of Aleph-w library
 
  Copyright (c) 2002-2026 Leandro Rabindranath Leon
 
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:
 
  The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.
 
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.
*/
 
 
# ifndef TPL_CUT_NODES_H
# define TPL_CUT_NODES_H
 
# include <ah-graph-concepts.H>
 
# include <tpl_graph_utils.H>
 
namespace Aleph
{
  template <AlephGraph GT, ArcFilter<GT> SA = Dft_Show_Arc<GT>>
  class Compute_Cut_Nodes
  {
    SA sa;
    GT *gptr = nullptr;
    DynDlist<typename GT::Node *> *list_ptr = nullptr;
    long curr_df = 0;
    long curr_color = 1;
 
    enum State { Init, Cut_Nodes_Computed, Painted } state;
 
    void cut_nodes(typename GT::Node *p, typename GT::Arc *a)
    {
      NODE_BITS(p).set_bit(Depth_First, true); // mark p as visited
      low<GT>(p) = df<GT>(p) = curr_df++; // assign df number
 
      // traverse arcs of p
      bool p_is_cut_node = false;
      for (Node_Arc_Iterator<GT, SA> i(p, sa); i.has_curr(); i.next_ne())
        {
          auto arc = i.get_curr();
          if (arc == a)
            continue; // a is the parent arc ==> ignore it
 
          auto tgt = i.get_tgt_node();
          if (IS_NODE_VISITED(tgt, Depth_First))
            {
              if (not IS_ARC_VISITED(arc, Depth_First)) // non-tree arc?
                low<GT>(p) = std::min(df<GT>(tgt), low<GT>(p));
              continue;
            }
 
          if (IS_ARC_VISITED(arc, Depth_First))
            continue;
 
          ARC_BITS(arc).set_bit(Depth_First, true); // mark arc
 
          cut_nodes(tgt, arc);
          low<GT>(p) = std::min(low<GT>(tgt), low<GT>(p));
          if (low<GT>(tgt) >= df<GT>(p) and df<GT>(tgt) != 0) // cut node?
            p_is_cut_node = true;
        }
 
      // at this point, p has already been explored recursively
      if (p_is_cut_node)
        {
          NODE_BITS(p).set_bit(Cut, true);
          list_ptr->append(p);
        }
    }
 
  public:
    void cut_nodes(typename GT::Node *start,
                   DynDlist<typename GT::Node *> & list)
    {
      curr_df = 0; // global visit counter
      list_ptr = &list;
 
      list_ptr->empty();
 
      gptr->for_each_node([](auto p) // initialize nodes
                            {
                              NODE_COUNTER(p) = 0;
                              NODE_BITS(p).reset();
                              low<GT>(p) = -1;
                            });
      gptr->reset_arcs();
 
      NODE_BITS(start).set_bit(Depth_First, true); // mark start
      df<GT>(start) = curr_df++;
 
      int call_counter = 0; // recursion call counter
 
      // Traverse arcs from start while the graph is not fully spanned
      for (Node_Arc_Iterator<GT, SA> it(start, sa);
           it.has_curr() and curr_df < gptr->get_num_nodes(); it.next_ne())
        {
          auto tgt = it.get_tgt_node();
          if (IS_NODE_VISITED(tgt, Depth_First))
            continue;
 
          auto arc = it.get_curr();
          if (IS_ARC_VISITED(arc, Depth_First))
            continue;
 
          ARC_BITS(arc).set_bit(Depth_First, true);
          cut_nodes(tgt, arc);
          ++call_counter;
        }
 
      if (call_counter > 1) // is the root an articulation point?
        { // yes ==> append it to the list
          NODE_BITS(start).set_bit(Cut, true);
          list_ptr->append(start);
        }
 
      state = Cut_Nodes_Computed;
    }
 
  private:
    void paint_subgraph(typename GT::Node *p)
    {
      assert(not is_a_cut_node <GT> (p));
 
      if (is_node_painted<GT>(p))
        return;
 
      paint_node<GT>(p, curr_color);
 
      for (Node_Arc_Iterator<GT, SA> it(p, sa); it.has_curr(); it.next_ne())
        {
          auto arc = it.get_curr();
          if (is_arc_painted<GT>(arc))
            continue;
 
          auto tgt = it.get_tgt_node();
          if (is_a_cut_node<GT>(tgt))
            continue;
 
          paint_arc<GT>(arc, curr_color);
          paint_subgraph(tgt);
        }
    }
 
    void paint_from_cut_node(typename GT::Node *p)
    {
      assert(is_a_cut_node <GT> (p));
 
      // Paint connected blocks adjacent to p with different colors
      for (Node_Arc_Iterator<GT, SA> it(p, sa); it.has_curr(); it.next_ne())
        {
          auto arc = it.get_curr();
 
          assert(not is_arc_painted <GT> (arc));
 
          auto tgt_node = it.get_tgt_node();
          if (is_a_cut_node<GT>(tgt_node)) // is it a cut arc?
            {
              ARC_BITS(arc).set_bit(Cut, true); // mark as cut arc
              continue; // move to next arc
            }
          paint_arc<GT>(arc, Cross_Arc); // mark as cross arc
          if (is_node_painted<GT>(tgt_node))
            continue;
 
          // paint the block reachable through this arc
          paint_subgraph(tgt_node);
 
          curr_color++; // next color (next arc belongs to a different block)
 
          assert(not is_arc_painted <GT> (arc));
        }
    }
 
    typename GT::Node * create_and_map_node(typename GT::Node *gp,
                                            const long & color,
                                            GT & sg)
    {
      (void) color;
      assert(get_color<GT>(gp) == color);
      assert(not IS_NODE_VISITED(gp, Build_Subtree));
 
      std::unique_ptr<typename GT::Node> tp_auto(new typename GT::Node(gp));
      sg.insert_node(tp_auto.get());
      GT::map_nodes(gp, tp_auto.get());
      NODE_BITS(gp).set_bit(Build_Subtree, true);
 
      return tp_auto.release();
    }
 
    void map_subgraph(GT & sg, typename GT::Node *gsrc, const long & color)
    {
      assert(get_color <GT> (gsrc) == color);
 
      auto tsrc = mapped_node<GT>(gsrc); // gsrc mapped into sg
 
      // Traverse arcs of gsrc and insert into sg those with the requested color
      for (Node_Arc_Iterator<GT, SA> i(gsrc, sa); i.has_curr(); i.next_ne())
        {
          auto garc = i.get_curr();
          if (get_color<GT>(garc) != color or IS_ARC_VISITED(garc, Build_Subtree))
            continue; // arc has a different color or was already visited
 
          ARC_BITS(garc).set_bit(Build_Subtree, true);
 
          auto gtgt = i.get_tgt_node();
 
          assert(get_color <GT> (gtgt) == color);
 
          typename GT::Node *ttgt = nullptr; // gtgt mapped into sg
          if (IS_NODE_VISITED(gtgt, Build_Subtree)) // already in sg?
            ttgt = mapped_node<GT>(gtgt);
          else
            ttgt = create_and_map_node(gtgt, color, sg);
 
          auto tarc = sg.insert_arc(tsrc, ttgt, garc->get_info());
          GT::map_arcs(garc, tarc);
 
          map_subgraph(sg, gtgt, color);
        }
    }
 
  public:
    Compute_Cut_Nodes(const GT & g, SA __sa = SA())
      : sa(__sa), gptr(&const_cast<GT &>(g)), state(Init)
    {
      /* empty */
    }
 
    void operator ()(DynDlist<typename GT::Node *> & list)
    {
      cut_nodes(gptr->get_first_node(), list);
    }
 
    void operator ()(typename GT::Node *start,
                     DynDlist<typename GT::Node *> & list)
    {
      cut_nodes(start, list);
    }
 
    long paint_subgraphs()
    {
      ah_logic_error_if(state != Cut_Nodes_Computed)
        << "Cut nodes have not been computed or the class is in another phase";
 
      gptr->reset_counter_nodes();
      gptr->reset_counter_arcs();
      curr_color = 1;
 
      // Traverse each cut node and paint its adjacent blocks
      for (typename DynDlist<typename GT::Node *>::Iterator i(*list_ptr);
           i.has_curr(); i.next_ne())
        paint_from_cut_node(i.get_curr());
 
      state = Painted;
 
      return curr_color;
    }
 
    void map_subgraph(GT & sg, const long & color)
    {
      ah_logic_error_if(state != Painted) << "Graph is not painted";
 
      clear_graph(sg);
 
      typename GT::Node *first = nullptr; // find the first node with the requested color
 
      for (typename GT::Node_Iterator it(*gptr); it.has_curr(); it.next_ne())
        if (get_color<GT>(it.get_curr()) == color)
          first = it.get_curr();
 
      if (first == nullptr) // did we find the color?
        ah_domain_error_if(first == nullptr) << "Color does not exist in the graph";
 
      // create first, insert it into sg, and map it
      create_and_map_node(first, color, sg);
      try
        {
          map_subgraph(sg, first, color); // map the component
        }
      catch (...)
        {
          clear_graph(sg);
        }
    }
 
    void map_cut_graph(GT & cut_graph,
                       DynDlist<typename GT::Arc *> & cross_arc_list)
    {
      ah_logic_error_if(state != Painted) << "Graph is not painted";
 
      clear_graph(cut_graph);
 
      // Traverse the cut-node list and insert them into cut_graph
      for (typename DynDlist<typename GT::Node *>::Iterator it(*list_ptr);
           it.has_curr(); it.next_ne())
        {
          auto gp = it.get_curr();
 
          assert(is_a_cut_node <GT> (gp));
 
          std::unique_ptr<typename GT::Node> tp_auto(new typename GT::Node(gp));
          cut_graph.insert_node(tp_auto.get());
          GT::map_nodes(gp, tp_auto.release());
        }
 
      // Traverse arcs of g:
      // - cut_graph will contain cut arcs (between cut nodes)
      // - cross_arc_list will contain cross arcs (from cut nodes to blocks)
      for (Arc_Iterator<GT, SA> it(*gptr, sa); it.has_curr(); it.next_ne())
        {
          auto garc = it.get_curr();
          if (is_a_cross_arc<GT>(garc))
            {
              cross_arc_list.append(garc);
              continue;
            }
 
          if (not is_an_cut_arc<GT>(garc))
            continue;
 
          typename GT::Node *src = mapped_node<GT>(gptr->get_src_node(garc));
          typename GT::Node *tgt = mapped_node<GT>(gptr->get_tgt_node(garc));
 
          assert(src != nullptr and tgt != nullptr);
 
          typename GT::Arc *arc =
              cut_graph.insert_arc(src, tgt, garc->get_info());
          GT::map_arcs(garc, arc);
        }
    }
 
    void compute_blocks(DynDlist<GT> & block_list,
                        GT & cut_graph,
                        DynDlist<typename GT::Arc *> & cross_arc_list)
    {
      ah_logic_error_if(state < Cut_Nodes_Computed) << "Cut nodes have not been computed";
 
      if (state == Cut_Nodes_Computed)
        paint_subgraphs();
 
      // curr_color is the NEXT unused color, so valid colors are 1 .. curr_color-1.
      // We allocate curr_color slots (indices 0 .. curr_color-1) so that
      // block at color c lives at blocks[c-1]; slot [0] remains unused / empty.
      const long & num_colors = curr_color;
 
      DynArray<GT *> blocks; // blocks in an array for fast access
      blocks.reserve(num_colors);
 
      // Create an ordered list of empty components by color i
      for (int i = 0; i < num_colors; ++i)
        blocks.access(i) = &block_list.append(GT());
 
      // Traverse nodes and copy/map according to color
      for (typename GT::Node_Iterator it(*gptr); it.has_curr(); it.next_ne())
        {
          auto p = it.get_curr();
          if (IS_NODE_VISITED(p, Build_Subtree))
            continue;
 
          if (is_a_cut_node<GT>(p))
            continue;
 
          const long color = get_color<GT>(p);
 
          GT & sg = *blocks.access(color - 1);
 
          create_and_map_node(p, color, sg);
 
          map_subgraph(sg, p, color);
        }
 
      map_cut_graph(cut_graph, cross_arc_list);
    }
  };
 
  // =========================================================================
  // Bridge finding (Tarjan low-link algorithm)
  // =========================================================================
 
  template <AlephGraph GT, ArcFilter<GT> SA = Dft_Show_Arc<GT>>
  class Compute_Bridges
  {
    SA sa;
    GT *gptr;
 
    void __dfs(typename GT::Node *p, typename GT::Arc *parent_arc,
               long & curr_df, DynList<typename GT::Arc *> & bridges)
    {
      NODE_BITS(p).set_bit(Depth_First, true);
      low<GT>(p) = df<GT>(p) = curr_df++;
 
      for (Node_Arc_Iterator<GT, SA> it(p, sa); it.has_curr(); it.next_ne())
        {
          auto arc = it.get_curr();
          if (arc == parent_arc)
            continue; // skip the arc we came from
 
          auto tgt = it.get_tgt_node();
 
          if (IS_NODE_VISITED(tgt, Depth_First))
            {
              // Back-edge: update low if this arc has not been traversed yet
              if (not IS_ARC_VISITED(arc, Depth_First))
                low<GT>(p) = std::min(df<GT>(tgt), low<GT>(p));
              continue;
            }
 
          if (IS_ARC_VISITED(arc, Depth_First))
            continue;
 
          ARC_BITS(arc).set_bit(Depth_First, true); // mark tree arc
 
          __dfs(tgt, arc, curr_df, bridges);
 
          low<GT>(p) = std::min(low<GT>(tgt), low<GT>(p));
 
          if (low<GT>(tgt) > df<GT>(p)) // bridge condition
            bridges.append(arc);
        }
    }
 
  public:
    Compute_Bridges(const GT & g, SA sa = SA())
      : sa(sa), gptr(&const_cast<GT &>(g))
    { /* empty */
    }
 
    DynList<typename GT::Arc *> find_bridges(typename GT::Node *start)
    {
      ah_domain_error_if(gptr->is_digraph()) << "Compute_Bridges: does not work on digraphs";
 
      DynList<typename GT::Arc *> bridges;
 
      if (gptr->get_num_nodes() == 0)
        return bridges;
 
      ah_invalid_argument_if(start == nullptr) << "Compute_Bridges::find_bridges(): start must be non-null";
 
      gptr->for_each_node([](auto p)
                            {
                              NODE_COUNTER(p) = 0;
                              NODE_BITS(p).reset();
                            });
      gptr->reset_arcs();
 
      long curr_df = 0;
      __dfs(start, nullptr, curr_df, bridges);
 
      // Cover disconnected components: any node not reached from start.
      gptr->for_each_node([&](auto p)
                            {
                              if (not IS_NODE_VISITED(p, Depth_First))
                                __dfs(p, nullptr, curr_df, bridges);
                            });
 
      // NODE_COOKIE holds low-link values (stored as longs); clear them.
      gptr->for_each_node([](auto p) { NODE_COOKIE(p) = nullptr; });
 
      return bridges;
    }
 
    DynList<typename GT::Arc *> find_bridges()
    {
      if (gptr->get_num_nodes() == 0)
        return DynList<typename GT::Arc *>{};
      return find_bridges(gptr->get_first_node());
    }
 
    DynList<typename GT::Arc *> operator()(typename GT::Node *start)
    {
      return find_bridges(start);
    }
 
    DynList<typename GT::Arc *> operator()()
    {
      return find_bridges();
    }
  };
 
  template <AlephGraph GT, ArcFilter<GT> SA = Dft_Show_Arc<GT>>
  DynList<typename GT::Arc *>
  find_bridges(const GT & g, typename GT::Node *start, SA sa = SA())
  {
    return Compute_Bridges<GT, SA>(g, sa).find_bridges(start);
  }
 
  template <AlephGraph GT>
  DynList<typename GT::Arc *> find_bridges(const GT & g)
  {
    return Compute_Bridges<GT>(g).find_bridges();
  }
} // end namespace Aleph
 
# endif // TPL_CUT_NODES_H