generate_graph.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 GENERATE_GRAPH_H
# define GENERATE_GRAPH_H
 
# include <ah-graph-concepts.H>
 
# include <fstream>
# include <tpl_dynArray.H>
# include <tpl_sort_utils.H>
# include <tpl_graph.H>
# include <topological_sort.H>
 
using namespace Aleph;
 
namespace Aleph {
 
 
  template <AlephGraph GT, ArcFilter<GT> SA> inline static
  bool is_there_a_double_arc(const GT *          g,
                             typename GT::Node * src,
                             typename GT::Node * tgt) noexcept
  {
    if (not g->is_digraph())
      return false;
 
    return search_arc<GT,SA>(*g, src, tgt) != nullptr and
      search_arc<GT,SA>(*g, tgt, src) != nullptr;
  }
 
 
  template <AlephGraph GT>
  static int search_node(DynArray<typename GT::Node *> & nodes,
                         typename GT::Node * p) noexcept
  {
    return sequential_search(nodes, p, 0, nodes.size() - 1);
  }
 
 
  template <AlephGraph GT,
            class Write_Node, class Write_Arc,
            class Shade_Node, class Shade_Arc, ArcFilter<GT> SA>
  void generate_graphpic(const GT &      g,
                         const double &  xdist,
                         const double &  ydist,
                         std::ostream & output)
  {
    DynArray<typename GT::Node *> nodes;
    typename GT::Node_Iterator it(g);
    for (int i = 0; it.has_curr(); it.next_ne(), ++i)
      {
        auto p = it.get_current_node_ne();
 
        nodes[i] = p;
 
        if (Shade_Node() (p).size() != 0)
          output << Shade_Node() (p) << " " << i << std::endl;
 
        const std::string text_node = Write_Node () (p);
 
        if (text_node.size() == 0)
          continue;
 
        output << "NODE-TEXT " << i << " \"" << text_node << "\" 0 0" << std::endl;
      }
 
    for (Arc_Iterator<GT, SA> it(g); it.has_curr(); it.next_ne())
      {
        auto a = it.get_current_arc_ne();
        auto src = g.get_src_node(a);
        auto tgt = g.get_tgt_node(a);
 
        const auto src_idx = search_node <GT> (nodes, src);
        const auto tgt_idx = search_node <GT> (nodes, tgt);
 
        if (is_there_a_double_arc <GT, SA> (&g, src, tgt))
          output << "CURVE-ARC " << src_idx << " " << tgt_idx << " "
                 << xdist/5 << " L" << std::endl;
        else
          output << "ARC " << src_idx << " " << tgt_idx << std::endl;
 
        if ( Shade_Arc()(a).size() != 0)
          output << Shade_Arc()(a) << " "
                 << src_idx << " " << tgt_idx << " " << std::endl;
 
        const std::string text_arc = Write_Arc() (a);
 
        if (text_arc.size() == 0)
          continue;
 
        output << "ARC-TEXT " <<  src_idx << " " << tgt_idx << " \""
               << text_arc << "\" 0 0 " << std::endl;
      }
  }
 
  template <AlephGraph GT,
            class Write_Node,
            class Write_Arc,
            class Shade_Node,
            class Shade_Arc,
            class Dashed_Node,
            class Dashed_Arc,
            ArcFilter<GT> SA,
            NodeFilter<GT> SN>
  void generate_graphviz(const GT & g, std::ostream & output,
                         const std::string & rankdir = "TB",
                         float ranksep          = 0.2,
                         float nodesep          = 0.2)
  {
    output << "// Generated by generate_graphviz() from Aleph-w library. See at:" << std::endl
           << "// http://webdelprofesor.ula.ve/ingenieria/lrleon/aleph/html/index.html" << std::endl
           << "// for documentation" << std::endl
           << "// Copyleft Leandro Rabindranath Leon lrleon@ula.ve" << std::endl
           << "// for using of graphviz system. See at http://graphviz.org/" 
           << std::endl << std::endl;
    std::string arc_str;
    if (g.is_digraph())
      {
        arc_str = " -> ";
        output << "digraph {" << std::endl;
      }
    else
      {
        arc_str = " -- ";
        output << "graph {" << std::endl;
      }
    output << std::endl
           << "rankdir = " << rankdir << std::endl
           << "style = none" << std::endl
           << "truecolor=false" << std::endl
           << "ranksep = " << ranksep << std::endl
           << "nodesep = " << nodesep << std::endl << std::endl;
 
    DynArray<typename GT::Node *> nodes;
 
    Node_Iterator<GT, SN> it(g);
    for (int i = 0; it.has_curr(); it.next_ne(), ++i)
      {
        output << i << " [ ";
 
        auto p = it.get_current_node_ne();
        nodes[i] = p;
 
        if (Shade_Node () (p))
          output << "style = bold ";
 
        const std::string text_node = Write_Node () (p);
 
        if (text_node.size() != 0)
          output << "label = \"" << text_node << "\"";
        output << "]" << std::endl;
      }
 
    output << std::endl;
 
    for (Arc_Iterator<GT, SA> it(g); it.has_curr(); it.next_ne())
      {
        auto a = it.get_current_arc_ne();
        auto src = g.get_src_node(a);
        auto tgt = g.get_tgt_node(a);
 
        auto src_idx = search_node <GT> (nodes, src);
        auto tgt_idx = search_node <GT> (nodes, tgt);
 
        output << src_idx << arc_str << tgt_idx << " [";
 
        if (Shade_Arc () (a))
          output << "style = bold ";
 
        const std::string text_arc = Write_Arc() (a);
 
        if (text_arc.size() != 0)
          output << "label = \"" << text_arc << "\"";
        output <<"]" << std::endl;
      }
 
    output << "}" << std::endl;
  }
 
 
  template <AlephGraph GT,
            class Node_Attr,
            class Arc_Attr,
            NodeFilter<GT> SN,
            ArcFilter<GT> SA>
  void generate_graphviz(const GT & g, std::ostream & out,
                         Node_Attr  node_attr = Node_Attr(),
                         Arc_Attr   arc_attr  = Arc_Attr(),
                         const std::string & rankdir     = "TB")
  {
    out << "// Generated by generate_graphviz() from Aleph-w library" << std::endl
        << "// See at:"
        << "// http://webdelprofesor.ula.ve/ingenieria/lrleon/aleph/html/index.html" << std::endl
        << "// for documentation of Aleph-w library" << std::endl
        << "// Copyleft Leandro Rabindranath Leon lrleon@ula.ve" << std::endl
        << "// for using of graphviz system. See at http://graphviz.org/"
        << std::endl << std::endl
        << (g.is_digraph() ? "digraph {" : "graph {") << std::endl
        << std::endl
        << "rankdir = " << rankdir << std::endl
        << std::endl
        << "// Node list" << std::endl
        << std::endl;
 
    DynMapTreap<typename GT::Node *, int> nodes_table;
 
    Node_Iterator<GT, SN> it(g);
    for (int i = 0; it.has_curr(); it.next_ne(), ++i)
      {
        auto p = it.get_current_node_ne();
 
        nodes_table.insert(p, i);
 
        out << i << " [ ";
 
        node_attr (g, p, out);
 
        out << "]" << std::endl;
      }
 
    out << std::endl
        << std::endl
        << "// Arc list" << std::endl
        << std::endl;
 
    const std::string arrow = g.is_digraph() ? "->" : "--";
 
    for (Arc_Iterator<GT, SA> it(g); it.has_curr(); it.next_ne())
      {
        auto a = it.get_current_arc_ne();
        auto src = g.get_src_node(a);
        auto tgt = g.get_tgt_node(a);
 
        const auto src_idx = nodes_table.find(src);
        const auto tgt_idx = nodes_table.find(tgt);
 
        out << src_idx << arrow << tgt_idx << " [";
        arc_attr (g, a, out) ;
        out << "]" << std::endl;
      }
 
    out << "}" << std::endl;
  }
 
  template <AlephGraph GT,
            class Node_Attr,
            class Arc_Attr,
            NodeFilter<GT> SN,
            ArcFilter<GT> SA>
  void digraph_graphviz(const GT & g, std::ostream & out,
                        Node_Attr  node_attr = Node_Attr(),
                        Arc_Attr   arc_attr  = Arc_Attr(),
                        const std::string & rankdir     = "LR")
  {
    out << "// Generated by generate_graphviz() from Aleph-w library" << std::endl
        << "// See at:"
        << "// http://webdelprofesor.ula.ve/ingenieria/lrleon/aleph/html/index.html" << std::endl
        << "// for documentation of Aleph-w library" << std::endl
        << "// Copyleft Leandro Rabindranath Leon lrleon@ula.ve" << std::endl
        << "// for using of graphviz system. See at http://graphviz.org/"
        << std::endl << std::endl
        << "digraph {" << std::endl
        << std::endl
        << "rankdir = " << rankdir << std::endl
        << std::endl
        << "// Node list" << std::endl
        << std::endl;
 
    DynMapTreap<typename GT::Node *, int> nodes_table;
 
    Node_Iterator<GT, SN> it(g);
    for (int i = 0; it.has_curr(); it.next_ne(), ++i)
      {
        auto p = it.get_current_node_ne();
        nodes_table.insert(p, i);
 
        out << i << " [ ";
 
        node_attr (g, p, out);
 
        out << "]" << std::endl;
      }
 
    out << std::endl
        << std::endl
        << "// Arc list" << std::endl
        << std::endl;
 
    const std::string arrow = "->";
 
    for (Arc_Iterator<GT, SA> it(g); it.has_curr(); it.next_ne())
      {
        auto a = it.get_current_arc_ne();
        auto src = g.get_src_node(a);
        auto tgt = g.get_tgt_node(a);
 
        const auto src_idx = nodes_table.find(src);
        const auto tgt_idx = nodes_table.find(tgt);
 
        out << src_idx << arrow << tgt_idx << " [";
        arc_attr (g, a, out) ;
        out << "]" << std::endl;
      }
 
    out << "}" << std::endl;
  }
 
  template <AlephGraph GT,
            class Node_Attr,
            class Arc_Attr,
            NodeFilter<GT> SN,
            ArcFilter<GT> SA>
  size_t rank_graphviz(const GT & g, std::ostream & out,
                       Node_Attr  node_attr = Node_Attr(),
                       Arc_Attr   arc_attr  = Arc_Attr(),
                       const std::string & rankdir     = "LR")
  {
    out << "// Generated by generate_graphviz() from Aleph-w library" << std::endl
        << "// See at:"
        << "// http://webdelprofesor.ula.ve/ingenieria/lrleon/aleph/html/index.html" << std::endl
        << "// for documentation of Aleph-w library" << std::endl
        << "// Copyleft Leandro Rabindranath Leon lrleon@ula.ve" << std::endl
        << "// for using of graphviz system. See at http://graphviz.org/"
        << std::endl << std::endl
        << "digraph {" << std::endl
        << std::endl
        << "rankdir = " << rankdir << std::endl
        << "rank = same" << std::endl
        << std::endl
        << "// Node list" << std::endl
        << std::endl;
 
    DynMapTreap<typename GT::Node*, size_t> nodes_table;
    DynList<DynList<typename GT::Node*>> ranks = Q_Topological_Sort<GT>().ranks(g);
    size_t rank = 0, i = 0;
    for (auto rank_it = ranks.get_it(); rank_it.has_curr();
         rank_it.next_ne(), ++rank)
      {
        out << "subgraph rank_" << rank << std::endl
            << "{" << std::endl
            <<  "label = \"rank " << rank << "\"" << std::endl;
        for (auto it = rank_it.get_curr().get_it(); it.has_curr();
             it.next_ne(), ++i)
          {
            auto p = it.get_curr();
            nodes_table.insert(p, i);
            out << i << " [ ";
            node_attr(g, p, out);
            out << "]" << std::endl;
          }
        out << "}" << std::endl;
      }
 
    out << std::endl
        << std::endl
        << "// Arc list" << std::endl
        << std::endl;
 
    const std::string arrow = "->";
    for (Arc_Iterator<GT, SA> it(g); it.has_curr(); it.next_ne())
      {
        auto a = it.get_current_arc_ne();
        auto src = g.get_src_node(a);
        auto tgt = g.get_tgt_node(a);
 
        const auto src_idx = nodes_table.find(src);
        const auto tgt_idx = nodes_table.find(tgt);
 
        out << src_idx << arrow << tgt_idx << " [";
        arc_attr (g, a, out) ;
        out << "]" << std::endl;
      }
    out << "}" << std::endl;
 
    return rank;
  }
 
  template <class GT>
  struct Dft_Node_Attr
  {
    void operator () (const GT&, typename GT::Node * p, std::ostream & out)
    {
      out << "label = \"" << p->get_info() << "\"";
    }
  };
 
  template <class GT>
  struct Dft_Arc_Attr
  {
    void operator () (const GT&, typename GT::Arc * a, std::ostream & out)
    {
      out << "label = \"" << a->get_info() << "\"";
    }
  };
 
  template <AlephGraph GT,
            class Node_Attr = Dft_Node_Attr<GT>,
            class Arc_Attr  = Dft_Arc_Attr<GT>,
            NodeFilter<GT> SN        = Dft_Show_Node<GT>,
            ArcFilter<GT> SA        = Dft_Show_Arc<GT>>
  struct To_Graphviz
  {
    void operator () (const GT & g, std::ostream & out,
                      const Node_Attr & node_attr = Node_Attr(),
                      const Arc_Attr & arc_attr   = Arc_Attr(),
                      const std::string & rankdir      = "LR")
    {
      generate_graphviz <GT, Node_Attr, Arc_Attr, SN, SA>
        (g, out, node_attr, arc_attr, rankdir);
    }
 
    void digraph(const GT & g, std::ostream & out,
                 const Node_Attr & node_attr = Node_Attr(),
                 const Arc_Attr & arc_attr   = Arc_Attr(),
                 const std::string & rankdir      = "LR")
    {
      digraph_graphviz <GT, Node_Attr, Arc_Attr, SN, SA>
        (g, out, node_attr, arc_attr, rankdir);
    }
 
    void ranks(const GT & g, std::ostream & out,
               const Node_Attr & node_attr = Node_Attr(),
               const Arc_Attr & arc_attr   = Arc_Attr(),
               const std::string & rankdir      = "LR")
    {
      rank_graphviz <GT, Node_Attr, Arc_Attr, SN, SA>
        (g, out, node_attr, arc_attr, rankdir);
    }
  };
 
 
 
  template <AlephGraph GT>
  struct Dummy_Attr
  {
    bool operator () (typename GT::Node *) const { return false; }
 
    bool operator () (typename GT::Arc *) const { return false; }
  };
 
 
  template <AlephGraph GT, 
            class Write_Node, 
            class Write_Arc,
            class Shade_Node = Dummy_Attr<GT>, 
            class Shade_Arc = Dummy_Attr<GT>,  
            class Dashed_Node = Dummy_Attr<GT>, 
            class Dashed_Arc = Dummy_Attr<GT>, 
            ArcFilter<GT> SA = Dft_Show_Arc<GT>,
            NodeFilter<GT> SN = Dft_Show_Node<GT> > 
  struct Generate_Graphviz
  {
    void operator () (GT & g, std::ostream & out,
                      const std::string & rankdir = "TB",
                      float ranksep = 0.4, float nodesep = 0.4)
    {
      generate_graphviz <GT, Write_Node, Write_Arc, Shade_Node, 
                         Shade_Arc, Dashed_Node, Dashed_Arc, SA, SN> 
        (g, out, rankdir, ranksep, nodesep);
    }
  };
 
  template <AlephGraph GT,
            class Write_Node, class Write_Arc,
            class Shade_Node, class Shade_Arc, ArcFilter<GT> SA>
  void generate_cross_graph(GT &            g, 
                            const size_t &  nodes_by_level, 
                            const double &  xdist,
                            const double &  ydist,
                            std::ostream & out)
  {
    if (g.is_digraph())
      out << "cross-net-digraph ";  
    else 
      out << "cross-net-graph "; 
 
    out << g.get_num_nodes() << " " << nodes_by_level << " " 
        << xdist << " " << ydist << std::endl 
        << std::endl;
  
    generate_graphpic<GT, Write_Node, Write_Arc, Shade_Node, Shade_Arc, SA>
      (g, xdist, ydist, out);
  }
 
  template <AlephGraph GT,
            class Write_Node, class Write_Arc,
            class Shade_Node, class Shade_Arc>
  void generate_cross_graph(GT &            g, 
                            const size_t &  nodes_by_level, 
                            const double &  xdist,
                            const double &  ydist,
                            std::ostream & out)
  {
    typedef Dft_Show_Arc<GT> DSA;
    generate_cross_graph<GT, Write_Node, Write_Arc, Shade_Node, Shade_Arc, DSA>
      (g, nodes_by_level, xdist, ydist, out);
  }
 
  template <AlephGraph GT, 
            class Write_Node, class Write_Arc,
            class Shade_Node, class Shade_Arc, ArcFilter<GT> SA>
  void generate_net_graph(GT &            g, 
                          const size_t &  nodes_by_level, 
                          const double &  xdist,
                          const double &  ydist,
                          std::ostream & out)
  {
    if (g.is_digraph())
      out << "net-digraph ";  
    else 
      out << "net-graph "; 
 
    out << g.get_num_nodes() << " " << nodes_by_level << " " 
        << xdist << " " << ydist << std::endl 
        << std::endl;
  
    generate_graphpic<GT, Write_Node, Write_Arc, Shade_Node, Shade_Arc, SA>
      (g, xdist, ydist, out);
  }
 
  template <AlephGraph GT, 
            class Write_Node, class Write_Arc,
            class Shade_Node, class Shade_Arc>
  void generate_net_graph(GT &            g, 
                          const size_t &  nodes_by_level, 
                          const double &  xdist,
                          const double &  ydist,
                          std::ostream & out)
  {
    typedef Dft_Show_Arc<GT> DSA;
    generate_net_graph<GT, Write_Node, Write_Arc, Shade_Node, Shade_Arc, DSA>
      (g, nodes_by_level, xdist, ydist, out);
    
  }
 
  template <AlephGraph GT> struct __Shade_Node
  {
    std::string operator () (typename GT::Node *) const
    {
      return "";
    }
  };
 
 
  template <AlephGraph GT> struct __Shade_Arc
  {
    std::string operator () (typename GT::Arc *) const
    {
      return "";
    }
  };
 
 
  template <AlephGraph GT, class Write_Node, class Write_Arc, ArcFilter<GT> SA>
  void generate_cross_graph(GT &            g, 
                            const size_t &  nodes_by_level, 
                            const double &  xdist,
                            const double &  ydist,
                            std::ostream & out)
  {
    generate_cross_graph
      <GT, Write_Node, Write_Arc, __Shade_Node<GT>, __Shade_Arc<GT>, SA>
      (g, nodes_by_level, xdist, ydist, out);
  }
 
  template <AlephGraph GT, class Write_Node, class Write_Arc, ArcFilter<GT> SA>
  void generate_net_graph(GT &            g, 
                          const size_t &  nodes_by_level, 
                          const double &  xdist,
                          const double &  ydist,
                          std::ostream & out)
  {
    generate_net_graph
      <GT, Write_Node, Write_Arc, __Shade_Node<GT>, __Shade_Arc<GT>, SA>
      (g, nodes_by_level, xdist, ydist, out);
  }
 
 
  template <AlephGraph GT, class Write_Node, class Write_Arc>
  void generate_cross_graph(GT &            g, 
                            const size_t &  nodes_by_level, 
                            const double &  xdist,
                            const double &  ydist,
                            std::ostream & out)
  {
    typedef Dft_Show_Arc<GT> DSA;
    generate_cross_graph
      <GT, Write_Node, Write_Arc, __Shade_Node<GT>, __Shade_Arc<GT>, DSA>
      (g, nodes_by_level, xdist, ydist, out);
  }
 
  template <AlephGraph GT, class Write_Node, class Write_Arc>
  void generate_net_graph(GT &            g, 
                          const size_t &  nodes_by_level, 
                          const double &  xdist,
                          const double &  ydist,
                          std::ostream & out)
  {
    typedef Dft_Show_Arc<GT> DSA;
    generate_net_graph 
      <GT, Write_Node, Write_Arc, __Shade_Node<GT>, __Shade_Arc<GT>, DSA>
      (g, nodes_by_level, xdist, ydist, out);
  }
 
 
} // end namespace Aleph    
 
 
# endif // GENERATE_GRAPH_H