SBG library API Draft

[joaquinffernandez]

Draft for SBG library API design

The goal of this document is to define a draft for the SBG Library API, the proposed design is the following:

Under this scheme we have:

• SBG API Interface: That is in charge of creating and using the SBG lib, the main purpose of this interface is to make client code agnostic of the concrete library implementation and also to give some notions of classic graphs in client code, to this end, we should use the DTO representation of the basic data structures needed by SBG.
• SBGDTOConverter: Use IDTOConverter interface to create the data structures exposed in client code. Note that probably some concrete DTOs will be almost identical to the ones we have now in the library, but the purpose of this interface is to remove data representation responsibilities from the library, convert data structures between the SBG::API and SBG::LIB and also we plan to use classic algorithms, for instance in the partitioner, the individual converters will be in charge of doing the conversion to the corresponding data types.

The development branch for this new feature is iss-25-define-sbg-lib-api, and it's open to any ideas, suggestions, naming convention discussions, etc.
@Kalashnikovni @francosansone @LucioTrincheri

[joaquinffernandez]

Possible pseudo-code implementation to add a new node:

namespace SBG {
namespace API {
template<typename UserData>
struct SetNode {
  SBG::API::Set nodes;
  UserData user_data;
}

template<typename UserData>
struct SetEdge {
  SBG::API::PWLMap map_1;
  SBG::API::PWLMap map_2;
  UserData user_data;
}

template<typename SetNode, typename SetEdge, typename NodeUserData, typename EdgeUserData>
class SBGraph {
...

void addNode(SetNode n) {
  SBG::LIB::OrdSet set = _sbg_dto_converter.convertToSBG(n.nodes);
  _graph.addSV(set);
  _node_user_data_map.insert(_graph.Vmap().image(set), n.user_data);
}

// Same with addEdge

protected:
   SBGDTOConverter _sbg_dto_converter;
   NodeUserDataMap _node_user_data_map;
   EdgeUserDataMap _edge_user_data_map;
   SBG::LIB::SBGraph _graph;
}
}