graphml.h

Go to the documentation of this file.

 
#include "elementa/license.inc"
#include "elementa/checks.inc"
 
#ifndef ELEMENTA_ADTS_GRAPHS_GRAPHML_H
#define ELEMENTA_ADTS_GRAPHS_GRAPHML_H
 
#include "elementa/adts/graphs/graphs.h"
 
#include "elementa/base/debugging.h"
 
 
namespace elementa
{
 
namespace adts
{
 
namespace graphs
{
 
/* ***************************************************************************
 
    Base class: Szer_GraphML
    
*******************************************************************************/
 
template <class Vertex, class Edge>
class Szer_GraphML: public elementa::base::Serializer<Graph<Vertex,Edge>>
{
 public:
 
    using BaseGraph = Graph<Vertex,Edge>;
 
 
    Szer_GraphML(const std::string & title,
                        elementa::base::Serializer<Vertex> * szerv = nullptr,
                        elementa::base::Serializer<Edge> * szere = nullptr,
                        const std::string & eol = "\r\n"):  
                                            tit_{title},
                                            eol_{eol},
                                            withvit0_{false},witheit0_{false},
                                            szerv_{szerv},
                                            szere_{szere} 
    { if (title.find('"') != std::string::npos)
        ELE_CODE_INVARG("Graph title cannot contain double quote characters"); }
 
    Szer_GraphML(const Szer_GraphML &) = delete;
    Szer_GraphML(Szer_GraphML &&) = delete;
    Szer_GraphML & operator=(const Szer_GraphML &) = delete;
    Szer_GraphML & operator=(Szer_GraphML &&) = delete;
 
 
    void setInitialVIt(const typename BaseGraph::viterator vit0)
        { vit0_ = vit0; withvit0_ = true; }
 
 
    void setInitialEIt(const typename BaseGraph::eiterator eit0)
        { eit0_ = eit0; witheit0_ = true; }
 
 
    void ser(elementa::base::OutSerCh & chout, const BaseGraph & graph);
 
    // Unimplemented deserializations.
 
    
 private:
 
    std::string tit_,eol_;
    bool withvit0_,witheit0_;
    typename BaseGraph::viterator vit0_;
    typename BaseGraph::eiterator eit0_;
    elementa::base::Serializer<Vertex> * szerv_;
    elementa::base::Serializer<Edge> * szere_;  
};
 
 
 
/* ===========================================================================
 
        ========== IMPLEMENTATION OF TEMPLATES ==========
 
============================================================================= */
 
/* ***************************************************************************
 
    Template class: Szer_GraphML
    
*******************************************************************************/
 
template <class Vertex, class Edge>
void Szer_GraphML<Vertex,Edge>::ser(elementa::base::OutSerCh & chout, 
                                    const BaseGraph & graph)
{ELE_CODE_TRACE_OFF;
 
    elementa::base::Szer_String szerstr{};
 
    // header
 
    szerstr.ser(chout,"<?xml version=\"1.0\" encoding=\"UTF-8\"?>" 
                  + eol_ +
                  "<graphml xmlns=\"http://graphml.graphdrawing.org/xmlns\""
                  + eol_ + 
                  "\txmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\""
                  + eol_ +
                  "\txsi:schemaLocation=\"http://graphml.graphdrawing.org/xmlns"
                  + eol_ + 
                  "\t\thttp://graphml.graphdrawing.org/xmlns/1.0/graphml.xsd\">"
                  + eol_ +
                  "<key attr.name=\"nodedata\" attr.type=\"string\" "
                  "for=\"node\" id=\"d0\"/>"
                  + eol_ +
                  "<key attr.name=\"edgedata\" attr.type=\"string\" "
                  "for=\"edge\" id=\"d1\"/>"
                  + eol_ +
                  "<key attr.name=\"label\" attr.type=\"string\" "
                  "for=\"node\" id=\"d3\"/>"
                  + eol_);
    
    szerstr.ser(chout,"<graph ");
    if (!tit_.empty()) szerstr.ser(chout,"id=\"" + tit_ + "\" ");
    szerstr.ser(chout,"edgedefault=\"directed\" parse.nodes=\"");
    szerstr.ser(chout,std::to_string(graph.size_vertices()));
    szerstr.ser(chout,"\" parse.edges=\"");
    szerstr.ser(chout,std::to_string(graph.size_edges()));
    szerstr.ser(chout,"\" >" + eol_);
 
    // vertices
 
    typename BaseGraph::VectorOfVIts vp2i;
    typename BaseGraph::viterator vit;
    if (withvit0_) vit = vit0_;
    else vit = graph.vrangeAll().begin();
    while (!vit.isEnd()) 
    {
        vp2i.push_back(vit);
        ++vit;
    }
    typename BaseGraph::MapOfVItPos vi2p{vp2i}; // same positions as in vp2i
    ELE_CODE_TRACE({},"Direct and indirect maps of vertices created with " << 
                        vp2i.size() << " items");
 
    for (size_t pos = 0; pos < vp2i.size(); ++pos)
    {
        szerstr.ser(chout,"\t<node id=\"n");
        szerstr.ser(chout,std::to_string(pos));
        szerstr.ser(chout,"\">" + eol_ + "\t\t<data key=\"d3\">#" + 
                          std::to_string(pos) + 
                          "</data>" + eol_);
        if (szerv_ != nullptr) 
        {
            szerstr.ser(chout,"\t\t<data key=\"d0\">");
            szerv_->ser(chout,*(vp2i[pos]));
            szerstr.ser(chout,"</data>" + eol_);
        }
        szerstr.ser(chout,"\t</node>" + eol_);
    }
 
    // edges
 
    typename BaseGraph::viterator v0,v1;
    typename BaseGraph::eiterator e;
    if (witheit0_) e = eit0_;
    else e = graph.erangeAll().begin();
    size_edge pe{0};
    while (!e.isEnd())
    {
        graph.connection(e,v0,v1);
            
        szerstr.ser(chout,"\t<edge id=\"e");
        szerstr.ser(chout,std::to_string(pe));
        szerstr.ser(chout,"\" directed=\"true\" source=\"n");
        szerstr.ser(chout,std::to_string(vi2p.at(v0)));
        szerstr.ser(chout,"\" target=\"n");
        szerstr.ser(chout,std::to_string(vi2p.at(v1)));
        szerstr.ser(chout,"\">" + eol_);
        if (szere_ != nullptr)
        {
            szerstr.ser(chout,"\t\t<data key=\"d1\">");
            szere_->ser(chout,*e);
            szerstr.ser(chout,"</data>" + eol_);
        }
        szerstr.ser(chout,"\t</edge>" + eol_);
    
        ++e;
        ++pe;
    }
 
    // footer
 
    szerstr.ser(chout,"</graph>" + eol_);
    szerstr.ser(chout,"</graphml>");
}
 
 
 // GraphML
 
} // end graphs namespace
 
} // end adts namespace
 
} // end elementa namespace
 
 
#endif