generate_tree.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_TREE_H
# define GENERATE_TREE_H
 
# include <fstream>
# include <string>
# include <tpl_tree_node.H>
# include <tpl_binNodeUtils.H>
# include <ah-errors.H>
 
namespace Aleph
{
  inline std::string escape_dot_label(const std::string & text)
  {
    std::string escaped;
    escaped.reserve(text.size());
 
    for (const char ch : text)
      switch (ch)
        {
        case '\\':
          escaped += "\\\\";
          break;
        case '"':
          escaped += "\\\"";
          break;
        case '\n':
          escaped += "\\n";
          break;
        case '\r':
          escaped += "\\r";
          break;
        case '\t':
          escaped += "\\t";
          break;
        default:
          escaped += ch;
        }
 
    return escaped;
  }
 
  template <class Node>
  struct Dft_Write
  {
    std::string operator ()(Node *p)
    {
      return to_str(p->get_key());
    }
  };
 
  /*
    Write debe exportar const std::string Write::operator () (Node *)
 
    Que se encarga de convertir el valor de clave contenido en el nodo a
    un std::string imprimible
  */
 
  template <typename Node, class Write>
  static
  void __generate_tree(Node *node,
                       int deway[],
                       const size_t & current_level,
                       const size_t & size,
                       std::ostream & output)
  {
    ah_overflow_error_if(current_level >= size)
      << "Allocated size for deway array has been exceeded";
 
    // imprimir número de Deway del padre
    output << "Node ";
    for (size_t i = 0; i < current_level; ++i)
      {
        output << deway[i];
 
        if (i < current_level - 1)
          output << ".";
      }
    output << " \"" << Write()(node) << "\" " << std::endl;
 
    Node *child = static_cast<Node *>(node->get_left_child());
    for (int i = 0; child != nullptr;
         i++, child = static_cast<Node *>(child->get_right_sibling()))
      {
        deway[current_level + 1] = i;
        __generate_tree<Node, Write>
            (child, deway, current_level + 1, size, output);
      }
  }
 
 
  constexpr size_t Max_Tree_Node_Depth = 1024;
 
  template <typename Node, class Write = Dft_Write<Node>>
  void generate_tree(Node *root,
                     std::ostream & out,
                     const int & tree_number = 0)
  {
    out << "Root \"" << Write()(root) << "\" " << std::endl;
 
    const auto deway = new int [Max_Tree_Node_Depth];
 
    constexpr int level = 0; // Este es el nivel de partida
 
    deway[level] = tree_number; // nivel 0 en el número del árbol
 
    Node *child = static_cast<Node *>(root->get_left_child());
    for (int i = 0; child != nullptr;
         i++, child = static_cast<Node *>(child->get_right_sibling()))
      {
        deway[1] = i;
        __generate_tree<Node, Write>(child, deway, level + 1,
                                     Max_Tree_Node_Depth, out);
      }
 
    delete [] deway;
  }
 
  template <typename Node, class Write = Dft_Write<Node>>
  void generate_forest(Node *root, std::ostream & out)
  {
    Node *tree = root;
 
    for (int i = 0; tree != nullptr; i++, tree = tree->get_right_sibling())
      generate_tree<Node, Write>(tree, out, i);
  }
 
 
  template <typename Node, class Write>
  void generate_btree(Node *root, std::ostream & out)
  {
    out << "start-prefix ";
    For_Each_Preorder<Node>()(root, Write());
    out << std::endl
        << "start_infix ";
    For_Each_In_Order<Node>()(root, Write());
    out << std::endl;
  }
 
  template <typename Node, class Write = Dft_Write<Node>>
  void generate_tree_graphviz(Node *root, std::ostream & out)
  {
    out << "digraph Tree {" << std::endl;
    out << "  node [shape=circle, fontname=\"Helvetica\"];" << std::endl;
    out << "  edge [fontname=\"Helvetica\"];" << std::endl;
 
    if (root == nullptr)
      {
        out << "}" << std::endl;
        return;
      }
 
    auto traverse = [&out](auto & self, Node * p) -> void {
      if (p == nullptr)
        return;
 
      out << "  \"" << p << "\" [label=\""
          << escape_dot_label(Write()(p)) << "\"];" << std::endl;
 
      for (typename Node::Children_Iterator it(p); it.has_curr(); it.next())
        {
          Node * child = it.get_curr();
          out << "  \"" << p << "\" -> \"" << child << "\";" << std::endl;
          self(self, child);
        }
    };
 
    traverse(traverse, root);
    out << "}" << std::endl;
  }
} // end namespace Aleph
 
# endif // GENERATE_TREE_H