ca-dot.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 CA_DOT_H
#define CA_DOT_H
 
#include <concepts>
#include <filesystem>
#include <fstream>
#include <ostream>
#include <sstream>
#include <string>
#include <utility>
 
#include <ah-errors.H>
 
#include <ca-frame-stream.H>
#include <tpl_ca_graph_automaton.H>
 
namespace Aleph {
namespace CA {
 
struct DOT_Render_Options
{
  std::string graph_name = "CA";  
  bool undirected = true;         
  bool include_labels = true;     
};
 
template <typename State>
struct Binary_DOT_Palette
{
  State dead{};                        
  std::string dead_colour = "white";   
  std::string alive_colour = "black";  
 
  [[nodiscard]] std::string operator()(const State &value) const
  {
    return value == dead ? dead_colour : alive_colour;
  }
};
 
namespace ca_dot_detail {
 
inline std::string quote(const std::string &s)
{
  std::ostringstream out;
  out << '"';
  for (const char c : s)
    {
      if (c == '"' or c == '\\')
        out << '\\';
      out << c;
    }
  out << '"';
  return out.str();
}
 
inline std::string quote_id_if_needed(const std::string &s)
{
  if (s.empty())
    return quote(s);
  const auto is_id_start = [](unsigned char c)
  {
    return (c >= 'a' and c <= 'z') or (c >= 'A' and c <= 'Z') or c == '_';
  };
  const auto is_id_cont = [&](unsigned char c)
  {
    return is_id_start(c) or (c >= '0' and c <= '9');
  };
  if (not is_id_start(static_cast<unsigned char>(s[0])))
    return quote(s);
  for (std::size_t i = 1; i < s.size(); ++i)
    if (not is_id_cont(static_cast<unsigned char>(s[i])))
      return quote(s);
  return s;
}
 
}  // namespace ca_dot_detail
 
template <typename Graph, typename Palette>
inline void render_graph_lattice_dot(std::ostream &out,
                                     const Graph &graph,
                                     Palette &&palette,
                                     const DOT_Render_Options &opts = {})
  requires requires(const Graph &g, std::size_t n, Palette &&p, const typename Graph::state_type &v) {
    g.size();
    g.neighbours(n);
    g.at_node(n);
    { p(v) } -> std::convertible_to<std::string>;
  }
{
  const char *kind = opts.undirected ? "graph" : "digraph";
  const char *edge = opts.undirected ? "--" : "->";
  out << kind << ' ' << ca_dot_detail::quote_id_if_needed(opts.graph_name) << " {\n";
  out << "  node [shape=circle, style=filled, fixedsize=true, width=0.42];\n";
 
  for (std::size_t n = 0; n < graph.size(); ++n)
    {
      const std::string fill = palette(graph.at_node(n));
      out << "  n" << n << " [fillcolor=" << ca_dot_detail::quote(fill);
      if (opts.include_labels)
        out << ", label=" << ca_dot_detail::quote(std::to_string(n));
      else
        out << ", label=\"\"";
      if (fill == "black" or fill == "#000000")
        out << ", fontcolor=\"white\"";
      out << "];\n";
    }
 
  for (std::size_t n = 0; n < graph.size(); ++n)
    {
      const auto &row = graph.neighbours(n);
      for (std::size_t k = 0; k < row.size(); ++k)
        {
          const std::size_t m = row[k];
          if (opts.undirected and m < n)
            continue;
          out << "  n" << n << ' ' << edge << " n" << m << ";\n";
        }
    }
  out << "}\n";
  ah_runtime_error_if(not out) << "render_graph_lattice_dot: output stream failed";
}
 
template <typename Graph, typename Palette>
[[nodiscard]] inline std::string render_graph_lattice_dot_string(const Graph &graph,
                                                                 Palette &&palette,
                                                                 const DOT_Render_Options &opts = {})
{
  std::ostringstream out;
  render_graph_lattice_dot(out, graph, std::forward<Palette>(palette), opts);
  return out.str();
}
 
template <typename Palette>
class Dot_Frame_Sink
{
  std::filesystem::path pattern_;
  Palette palette_;
  DOT_Render_Options opts_{};
  std::size_t zero_pad_ = 6;
 
public:
  Dot_Frame_Sink(std::filesystem::path path_pattern,
                 Palette palette,
                 DOT_Render_Options opts = {},
                 const std::size_t zero_pad = 6)
    : pattern_(std::move(path_pattern)), palette_(std::move(palette)), opts_(std::move(opts)),
      zero_pad_(zero_pad)
  {}
 
  template <typename Graph>
  void accept(const std::size_t step, const Graph &graph)
  {
    const std::filesystem::path path = format_step_path(pattern_, step, zero_pad_);
    if (const auto parent = path.parent_path(); not parent.empty())
      std::filesystem::create_directories(parent);
    std::ofstream out(path);
    ah_runtime_error_if(not out) << "Dot_Frame_Sink::accept: cannot open '" << path.string() << "'";
    render_graph_lattice_dot(out, graph, palette_, opts_);
  }
 
  static void flush() {}
};
 
template <typename Palette>
Dot_Frame_Sink(std::filesystem::path, Palette, DOT_Render_Options = {}, std::size_t = 6)
  -> Dot_Frame_Sink<Palette>;
 
}  // namespace CA
}  // namespace Aleph
 
#endif  // CA_DOT_H