Merge pull request #790 from os-fpga/checker_NW_io_methods

checker: added initial NW (pinGraph) CSV-IO methods

Author: serge-dsa

planning/src/main.cpp

@@ -1,4 +1,4 @@
-static const char* _pln_VERSION_STR = "pln0306";
+static const char* _pln_VERSION_STR = "pln0307";
 
 #include "RS/rsEnv.h"
 #include "util/pln_log.h"

planning/src/util/nw/Nw.cpp

@@ -281,19 +281,6 @@ bool NW::hasClockNodes() const noexcept {
   return false;
 }
 
-// ==== DEBUG
-
-void NW::dot_comment(ostream& os, uint16_t dotMode, CStr msg) noexcept {
-  if (!dotMode) return;
-  if (dotMode == 1) {
-    os << s_dotComment;
-  } else {
-    assert(dotMode == 2);
-    os << s_metisComment;
-  }
-  if (msg) os << msg;
-}
-
 bool NW::verifyOneRoot() const noexcept {
   if (empty()) return true;
   assert(!rids_.empty());
@@ -310,277 +297,6 @@ bool NW::verifyOneRoot() const noexcept {
   return true;
 }
 
-void NW::Node::print(ostream& os) const noexcept {
-  using std::endl;
-  os << "id:" << id_;
-  if (XY::valid())
-    os << " (" << x_ << ' ' << y_ << ')';
-  else
-    os << " ( )";
-
-  os << " key=" << key_ << " deg=" << degree();
-  if (isTreeRoot()) {
-    if (isFlagRoot())
-      os << " R+";
-    else
-      os << " R-";
-  } else if (isFlagRoot()) {
-    os << " r-";
-  }
-  if (sink_flag_) os << " S";
-  os_printf(os, " par=%u lbl=%u", par_, lbl_);
-  if (not name_.empty())
-    os << " nm= " << name_;
-  os << endl;
-}
-
-static void replace_bus_for_dot(char* buf) noexcept {
-  assert(buf);
-  // replace [] by __
-  for (char* p = buf; *p; p++) {
-    if (*p == '[' or *p == ']')
-      *p = '_';
-  }
-}
-
-void NW::Node::nprint_dot(ostream& os) const noexcept {
-  char name_buf[2048] = {};
-  getName(name_buf);
-  replace_bus_for_dot(name_buf);
-
-  char attrib[512] = {};
-
-  if (!inp_flag_ and !clk_flag_) {
-    if (isRed())
-      ::strcpy(attrib, "[ shape=record, color=red, style=rounded ];");
-    else
-      ::strcpy(attrib, "[ shape=record, style=rounded ];");
-  }
-  else {
-    if (inp_flag_) {
-      CStr cs = isRed() ? "red" : "gray";
-      ::sprintf(attrib, "[ shape=box, color=%s, style=filled ];", cs);
-    }
-    else if (clk_flag_) {
-      CStr cs = isRed() ? "red" : "orange";
-      ::sprintf(attrib, "[ shape=record, color=%s, style=filled ];", cs);
-    }
-  }
-
-  os_printf(os, "%s  %s  // deg= %u;\n",
-            name_buf, attrib, degree());
-}
-
-void NW::Edge::eprint_dot(ostream& os, char arrow, const NW& g) const noexcept {
-  assert(arrow == '>' or arrow == '-');
-  char buf[2048] = {};
-  g.nodeRef(n1_).getName(buf);
-  replace_bus_for_dot(buf);
-  os_printf(os, "%s -%c ", buf, arrow);
-
-  buf[0] = 0;
-  g.nodeRef(n2_).getName(buf);
-  replace_bus_for_dot(buf);
-  os << buf;
-
-  char attrib[512] = {};
-  ::sprintf(attrib, " [%s %s",
-      inCell_ ? "style=dashed" : "",
-      color_ ? "color=" : ""
-      );
-  if (color_)
-    ::strcat(attrib, i2color(color_));
-  ::strcat(attrib, " ]");
-
-  os_printf(os, "%s;\n", attrib);
-}
-
-uint NW::print(ostream& os, CStr msg) const noexcept {
-  using std::endl;
-  if (msg) os << msg << endl;
-
-  if (empty()) {
-    os << " empty" << endl;
-    return 0;
-  }
-
-  uint r0 = first_rid();
-  os << "nn=" << size() << " ne=" << numE() << " nr=" << rids_.size() << " root0:" << r0 << endl;
-
-  for (cNI I(*this); I.valid(); ++I) {
-    const Node& nd = *I;
-    nd.print(os);
-  }
-
-  os << " nids_:" << endl;
-  for (uint i = 0; i < nids_.size(); i++) os << i << ": " << nid_at(i) << endl;
-
-  return size();
-}
-uint NW::dump(CStr msg) const noexcept { return print(lout(), msg); }
-
-uint NW::printNodes(ostream& os, CStr msg, uint16_t forDot) const noexcept {
-  using std::endl;
-  if (msg) {
-    os_printf(os, "%s %s\n", s_dotComment, msg);
-  }
-
-  if (empty()) {
-    os_printf(os, "%s empty\n", s_dotComment);
-    return 0;
-  }
-
-  for (cNI I(*this); I.valid(); ++I) {
-    const Node& nd = *I;
-    if (forDot == 1)
-      os << s_dotComment << ' ';
-    nd.print(os);
-  }
-
-  return size();
-}
-uint NW::dumpNodes(CStr msg) const noexcept { return printNodes(lout(), msg, 0); }
-
-uint NW::printEdges(ostream& os, CStr msg) const noexcept {
-  using std::endl;
-  if (msg) os << msg << endl;
-
-  uint esz = numE();
-  os_printf(os, "  nw:%s  esz= %u\n", nw_name_.c_str(), esz);
-  if (esz) {
-    for (cEI I(*this); I.valid(); ++I) {
-      I->print(os);
-      os << endl;
-    }
-  }
-  return esz;
-}
-uint NW::dumpEdges(CStr msg) const noexcept { return printEdges(lout(), msg); }
-
-uint NW::printSum(ostream& os, uint16_t forDot) const noexcept {
-  dot_comment(os, forDot);
-  if (empty()) {
-    os_printf(os, "  nw:%s  (empty NW)\n)", nw_name_.c_str());
-    return 0;
-  }
-  os_printf(os, "nw:%s\n", nw_name_.c_str());
-
-  upair mmD = getMinMaxDeg();
-  upair mmL = getMinMaxLbl();
-  upair rcnt = countRoots();
-  uint numClkNodes = countClockNodes();
-
-  dot_comment(os, forDot);
-  os_printf(os, "nn= %u  ne= %u  nr= %zu  r0= %u  #clkn= %u",
-            numN(), numE(), rids_.size(), first_rid(), numClkNodes);
-
-  os_printf(os, "  mm-deg: (%u,%u)", mmD.first, mmD.second);
-  os_printf(os, "  mm-lbl: (%u,%u)\n", mmL.first, mmL.second);
-
-  dot_comment(os, forDot);
-  os_printf(os, "nr=(%u,%u)\n", rcnt.first, rcnt.second);
-
-  return size();
-}
-
-uint NW::printMetis(ostream& os, bool nodeTable) const noexcept {
-  using std::endl;
-  if (!printSum(os, 2)) return 0;
-  if (nodeTable) {
-    printNodes(os, nullptr, 2);
-    os_printf(os, "%s====\n", s_metisComment);
-  }
-  os << numN() << ' ' << numE() << endl;
-
-  vecu A;
-  for (cNI I(*this); I.valid(); ++I) {
-    A.clear();
-    const Node& nd = *I;
-    nd.getAdj(*this, A);
-    os << nd.id_;
-    for (uint a : A) os << ' ' << a;
-    os << endl;
-  }
-  return size();
-}
-uint NW::dumpMetis(bool nodeTable) const noexcept { return printMetis(lout(), nodeTable); }
-
-bool NW::writeMetis(CStr fn, bool nodeTable) const noexcept {
-  assert(fn);
-  if (!fn or !fn[0]) return false;
-  if (empty()) return false;
-
-  bool ok = true;
-  uint status = 0;
-
-  std::ofstream f(fn);
-  if (f.is_open()) {
-    status = printMetis(f, nodeTable);
-    if (trace_ >= 3) lprintf(" written %s  status: %u\n\n", fn, status);
-    f.close();
-  } else {
-    if (trace_ >= 2) lprintf("\n [Error Metis] not f.is_open(),  fn: %s\n\n", fn);
-    ok = false;
-  }
-
-  return (ok and status > 0);
-}
-
-uint NW::printDot(ostream& os, CStr nwNm, bool nodeTable, bool noDeg0) const noexcept {
-  if (!printSum(os, 1)) return 0;
-  if (nodeTable) {
-    printNodes(os, nullptr, 1);
-    os_printf(os, "%s====\n", s_dotComment);
-  }
-
-  if (!nwNm or !nwNm[0]) {
-    if (not nw_name_.empty())
-      nwNm = nw_name_.c_str();
-  }
-  os_printf(os, "\ndigraph %s {\n", (nwNm and nwNm[0]) ? nwNm : "G");
- 	os_printf(os, "  label=\"%s\";\n", (nwNm and nwNm[0]) ? nwNm : "G");
-
-  // os << "  node [rankdir=LR];\n";
-  os << "  node [shape = record];\n";
-
-  for (cNI I(*this); I.valid(); ++I) {
-    const Node& ii = *I;
-    if (noDeg0 and ii.degree() == 0)
-      continue;
-    ii.nprint_dot(os);
-  }
-  os << std::endl;
-
-  for (cEI I(*this); I.valid(); ++I) {
-    I->eprint_dot(os, '>', *this);
-  }
-
-  os_printf(os, "}\n");
-  return size();
-}
-uint NW::dumpDot(CStr nwNm) const noexcept { return printDot(lout(), nwNm, false, false); }
-
-bool NW::writeDot(CStr fn, CStr nwNm, bool nodeTable, bool noDeg0) const noexcept {
-  assert(fn);
-  if (!fn or !fn[0]) return false;
-  if (empty()) return false;
-
-  bool ok = true;
-  uint status = 0;
-
-  std::ofstream f(fn);
-  if (f.is_open()) {
-    status = printDot(f, nwNm, nodeTable, noDeg0);
-    if (trace_ >= 3) lprintf(" written %s  status: %u\n\n", fn, status);
-    f.close();
-  } else {
-    if (trace_ >= 2) lprintf("\n [Error Dot-file] not f.is_open(),  fn: %s\n\n", fn);
-    ok = false;
-  }
-
-  return (ok and status > 0);
-}
-
 void NW::beComplete() noexcept {
   assert(selfCheck());
   clearEdges();
@@ -605,30 +321,12 @@ void NW::beComplete() noexcept {
   }
 }
 
-static const char* _colorNames[] = {
-  "black",
-  "red",
-  "orange",
-  "yellow",
-  "green",
-  "blue",
-  "firebrick",
-  "darkslategray",
-  "purple",
-  "aquamarine3",
-  "chocolate4",
-  "cadetblue4",
-  "darkolivegreen4",
-  "darkorchid4",
-  "cyan",
-  "goldenrod3",
-  "black",
-  "black",
-  "black"
-};
-
-CStr NW::i2color(uint i) noexcept {
-  return _colorNames[ i % (c_MAX_COLOR + 1) ];
+void NW::beStar() noexcept {
+  assert(selfCheck());
+  clearEdges();
+
+  if (size() < 2) return;
+
 }
 
 }

planning/src/util/nw/Nw.h

@@ -462,6 +462,8 @@ struct NW {
 
   bool verifyOneRoot() const noexcept;
 
+  // -- DEBUG and IO:
+
   static CStr i2color(uint i) noexcept;
 
   uint print(ostream& os, CStr msg = nullptr) const noexcept;
@@ -481,7 +483,12 @@ struct NW {
   uint dumpDot(CStr nwNm) const noexcept;
   bool writeDot(CStr fn, CStr nwNm, bool nodeTable, bool noDeg0) const noexcept;
 
+  uint printCsv(ostream& os) const noexcept;
+  uint dumpCsv() const noexcept;
+  bool writeCsv(CStr fn) const noexcept;
+
   void beComplete() noexcept;
+  void beStar() noexcept;
 
   static constexpr CStr s_metisComment = R"(%% )";
   static constexpr CStr s_dotComment = R"(// )";