tpl_sgraph.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_SGRAPH_H
# define TPL_SGRAPH_H
 
# include <memory>
# include <htlist.H>
# include <tpl_graph.H>
# include <tpl_dynSetTree.H>
# include <ah-errors.H>
 
namespace Aleph
{
  template <typename Node_Info = Empty_Class>
  struct Graph_Snode : public GTNodeCommon<Node_Info>
  {
    using Base = GTNodeCommon<Node_Info>;
    friend class GTNodeCommon<Node_Info>;
 
    DynList<void *> arc_list; 
 
    Graph_Snode(const Node_Info & info)
      : Base(info)
    {
      /* empty */
    }
 
    Graph_Snode(Node_Info && info = Node_Info())
      : Base(std::move(info))
    {
      /* empty */
    }
 
    Graph_Snode(const Graph_Snode & node)
      : Graph_Snode(node.node_info)
    {
      /* empty */
    }
 
    Graph_Snode &operator =(const Graph_Snode & node)
    {
      if (&node == this)
        return *this;
      this->node_info = node.node_info;
      return *this;
    }
 
    Graph_Snode(Graph_Snode *node)
      : Base(node->get_info())
    {
      /* empty */
    }
  };
 
  template <typename Arc_Info = Empty_Class>
  class Graph_Sarc : public GTArcCommon<Arc_Info>
  {
    using Base = GTArcCommon<Arc_Info>;
 
  public:
    Graph_Sarc(const Arc_Info & info)
      : Base(info)
    {
      /* empty */
    }
 
    Graph_Sarc(Arc_Info && info = Arc_Info())
      : Base(std::move(info))
    {
      /* empty */
    }
 
    Graph_Sarc(const Graph_Sarc & arc)
      : Graph_Sarc(arc.arc_info)
    {
      /* empty */
    }
 
    Graph_Sarc &operator =(const Graph_Sarc & arc)
    {
      if (&arc == this)
        return *this;
      this->arc_info = arc.arc_info;
      return *this;
    }
 
    Graph_Sarc(void *src, void *tgt, const Arc_Info & data)
      : Base(src, tgt, data)
    {
      // empty
    }
 
    Graph_Sarc(void *src, void *tgt, Arc_Info && data)
      : Base(src, tgt, std::move(data))
    {
      // empty
    }
  };
 
 
  template <typename __Graph_Node = Graph_Snode<unsigned long>,
            typename __Graph_Arc = Graph_Sarc<unsigned long>>
  class List_SGraph
      : public GraphCommon<List_SGraph<__Graph_Node, __Graph_Arc>,
                           __Graph_Node, __Graph_Arc>
  {
  public:
    using Node = __Graph_Node;
    using Arc = __Graph_Arc;
    using Node_Type = typename Node::Node_Type;
    using Arc_Type = typename Arc::Arc_Type;
 
    friend class GraphCommon<List_SGraph<__Graph_Node, __Graph_Arc>,
                             __Graph_Node, __Graph_Arc>;
 
    using CommonBase = GraphCommon<List_SGraph<__Graph_Node, __Graph_Arc>,
                                   __Graph_Node, __Graph_Arc>;
 
    using CommonBase::insert_node;
    using CommonBase::insert_arc;
 
  private:
    using DynSetNode = DynSetTree<Node *, Rand_Tree>;
    using DynSetArc = DynSetTree<Arc *, Rand_Tree>;
 
    DynSetNode node_list; 
    DynSetArc arc_list; 
 
  public:
    List_SGraph() = default;
 
    virtual ~List_SGraph()
    {
      clear();
    }
 
    void swap(List_SGraph & g) noexcept
    {
      this->common_swap(g);
      node_list.swap(g.node_list);
      arc_list.swap(g.arc_list);
    }
 
    ALEPH_GRAPH_COPY_MOVE_CTORS(List_SGraph)
 
    
    class Node_Iterator : public DynSetNode::Iterator
    {
    public:
      using Item_Type = Node *;
 
      using Set_Type = List_SGraph;
 
      Node_Iterator() = default;
 
      Node_Iterator(const List_SGraph & g) noexcept
        : DynSetNode::Iterator(g.node_list)
      {
        // empty
      }
 
      Node * get_current_node() const
      {
        return this->get_curr();
      }
 
      Node * get_current_node_ne() const noexcept
      {
        return this->get_curr_ne();
      }
    };
 
    class Node_Arc_Iterator : public DynList<void *>::Iterator
    {
      Node *src_node;
 
    public:
      using Item_Type = Arc *;
 
      using Set_Type = Node *;
 
      Node_Arc_Iterator() = default;
 
      Node_Arc_Iterator(Node *src) noexcept
        : DynList<void *>::Iterator(src->arc_list), src_node(src)
      {
        // empty
      }
 
      Arc * get_curr_ne() const noexcept
      {
        return static_cast<Arc *>(this->Iterator::get_curr_ne());
      }
 
      Arc * get_curr() const
      {
        return static_cast<Arc *>(this->Iterator::get_curr());
      }
 
      Arc * get_current_arc_ne() const noexcept
      {
        return get_curr_ne();
      }
 
      Arc * get_current_arc() const
      {
        return get_curr();
      }
 
      Node * get_tgt_node_ne() const noexcept
      {
        Arc *a = get_curr_ne();
        return static_cast<Node *>(a->get_connected_node(src_node));
      }
 
      Node * get_tgt_node() const
      {
        Arc *a = get_curr();
        return static_cast<Node *>(a->get_connected_node(src_node));
      }
    };
 
    class Arc_Iterator : public DynSetArc::Iterator
    {
    public:
      using Item_Type = Arc *;
 
      using Set_Type = List_SGraph;
 
      Arc_Iterator() = default;
 
      Arc_Iterator(const List_SGraph & _g) noexcept
        : DynSetArc::Iterator(_g.arc_list)
      {
        // empty
      }
 
      Arc * get_current_arc_ne() const noexcept
      {
        return this->get_curr_ne();
      }
 
      Node * get_src_node_ne() const noexcept
      {
        return static_cast<Node *>(get_current_arc_ne()->src_node);
      }
 
      Node * get_tgt_node_ne() const noexcept
      {
        return static_cast<Node *>(get_current_arc_ne()->tgt_node);
      }
 
      Arc * get_current_arc() const
      {
        return this->get_curr();
      }
 
      Node * get_src_node() const { return static_cast<Node *>(get_current_arc()->src_node); }
 
      Node * get_tgt_node() const { return static_cast<Node *>(get_current_arc()->tgt_node); }
    };
 
 
    virtual Node * insert_node(Node *p)
    {
      assert(p->arc_list.is_empty());
 
      ++this->num_nodes;
      node_list.append(p);
      return p;
    }
 
  private:
    Arc * insert_arc(Node *src, Node *tgt, void *a)
    {
      Arc *arc = static_cast<Arc *>(a);
 
      arc->src_node = src;
      arc->tgt_node = tgt;
 
      src->arc_list.append(a);
      ++src->num_arcs;
      if (not this->digraph and src != tgt)
        {
          tgt->arc_list.append(a);
          ++tgt->num_arcs;
        }
 
      arc_list.append(arc);
      ++this->num_arcs;
 
      return arc;
    }
 
    void disconnect_arc(Arc *arc)
    {
      Node *src = static_cast<Node *>(arc->src_node);
      Node *tgt = static_cast<Node *>(arc->tgt_node);
 
      src->arc_list.remove_ne([arc](auto a) { return a == arc; });
      --src->num_arcs;
 
      if (not this->digraph and src != tgt)
        {
          tgt->arc_list.remove_ne([arc](auto a) { return a == arc; });
          --tgt->num_arcs;
        }
    }
 
  public:
    virtual void remove_arc(Arc *arc) noexcept
    {
      disconnect_arc(arc);
      arc_list.remove(arc);
      --this->num_arcs;
      delete arc;
    }
 
    virtual void remove_node(Node *p) noexcept
    {
      DynList<Arc *> arcs_to_remove;
      arc_list.for_each([this, &arcs_to_remove, p](auto arc)
                          {
                            if (this->get_src_node(arc) == p or this->get_tgt_node(arc) == p)
                              {
                                this->disconnect_arc(arc);
                                --this->num_arcs;
                                arcs_to_remove.append(arc);
                              }
                          });
 
      arcs_to_remove.for_each([this](auto a)
                                {
                                  arc_list.remove(a);
                                  delete a;
                                });
      node_list.remove(p);
      --this->num_nodes;
 
      delete p;
    }
 
    Node * get_first_node() const
    {
      return static_cast<Node *>(node_list.get_first());
    }
 
    Arc * get_first_arc() const
    {
      return static_cast<Arc *>(arc_list.get_first());
    }
 
    Arc * get_first_arc(Node *p) const
    {
      ah_range_error_if(this->get_num_arcs(p) == 0) << "Node has no arcs";
      return static_cast<Arc *>(p->arc_list.get_first());
    }
 
  private:
    void clear() noexcept
    {
      arc_list.for_each([](Arc *p) { delete p; });
      node_list.for_each([](Node *p) { delete p; });
    }
 
  public:
    template <class Compare>
    void sort_arcs(Compare & cmp)
    {
      DynList<Arc *> temp_list;
      arc_list.for_each([&temp_list](Arc *a) { temp_list.append(a); });
      arc_list.empty();
 
      // Sort the temporary list
      mergesort(temp_list, cmp);
 
      // Rebuild the arc_list from sorted order
      temp_list.for_each([this](Arc *a) { arc_list.append(a); });
    }
 
    template <class Compare>
    void sort_arcs(Compare && cmp = Compare())
    {
      sort_arcs(cmp);
    }
  };
 
  template <typename __Graph_Node = Graph_Snode<int>,
            typename __Graph_Arc = Graph_Sarc<int>>
  using List_SDigraph = Digraph<List_SGraph<__Graph_Node, __Graph_Arc>>;
} // end namespace Aleph
 
# endif /* TPL_SGRAPH_H */