GSoC/2019/StatusReports/CaioTonetti

Project Overview

Project Name: An Improved Graph Theory IDE
Purpose: As a student, I use graphs in almost everything related to my master’s research. Graph Theory is a great mathematical tool for programmers and mathematicians, as it facilitates some computational problems resolution and modelling. However, is not always easy to understand the underlying theory and algorithms.

Rocs (https://kde.org/applications/education/rocs) is a Graph Theory IDE created in January of 2010, with new updates still being committed almost every month, currently in the KDE repositories, designed for lecturers, students and researchers. It is composed of a visual data structure and a powerful scripting engine in Javascript. Though useful for creating simple graphs, it is still lacking the tools to simplify the creation of bigger graphs, and also of basic graph theory algorithms for beginners. Another improvement it should have is a step by step execution system, in order to fully comprehend the algorithms and facilitate debugging.

List of Added Features

I have added the following features:

• Path Graph Creation Tool;
• Complete Graph Creation Tool;
• Complete Bipartite Graph Creation Tool;
• Random Directed Acyclical Graph Creation Tool;
• Random Tree Creation Tool (Modified to a more well behaved random tree creation tool);
• Script Examples:
  • Added Depth-First Search Algorithm;
  • Fixed Breadth-First Search Algorithm;
  • Added Topological Sorting Algorithm;
  • Fixed Prim Algorithm;
  • Added Kruskal Algorithm;
  • Added Dijkstra Algorithm;
  • Added Bellman-Ford Algorithm;
  • Added Floyd-Warshall Algorithm;
  • Added Bipartite Matching Algorithm.
• Added a interface to access the debugger tools (QScriptEngineDebugger) of our main script engine (QScriptEngine). But this one may be reworked to the new QJsEngine in the future, as the classes we are using today are not present in the default Qt installation (But they can be compiled separately);
• Added a interface to Transform Edges to remove self-edges from the graphs;
• Miscellaneous Changes:
  • Removed the "default" edge type and created two new "unidiretional" and "bidiretional" edge types.
  • Default values for the some graph classes;
  • Variable names fixes;
  • Redundant code removal;
  • Changed the Mersenne Twister from the booster library to the standard library;
  • Fixed the Generator Seeds of the graph generator widget;
  • Changed the Topology class to static access only;
  • Added correct edge type check on the DAG and Tree creation tools;
  • Information about the algorithm and time complexiy of all added script examples.

Information

Graph Creation Tools

All Graph Creation tools planned were implemented in the ROCS software. In this part, the generation of Cycles (called circle graph in ROCS) and random graphs were already implemented, so it was not listed as implemented in the feature list.

A additional modification was made on the Tree generation algorithm, as he was generating invalid tree graphs depending on which edge direction was used in the generator (resulting in cycles). The new algorithm used is presented in this paper, and it is proved that it can generate all possible tree with equal probabilities.

Step-by-Step Execution and Debugging

This feature is provided by the use of the QScriptEngineDebugger class, that already offers a complete debugger interface for the QScriptEngine, as can be seen in the Debugger Interface image.

Debugger Interface

So, a special button was created to identify when the programmer want to use the debugger or not (showed in the Debugger Button image). When it is clicked, the debugger will be launched with the code being run and the programmer can debug the code properly. Otherwise the code will be run normally.

Debugger Button

It is important to note that the support for the Webkit in Qt is deprecated and should be target of revision in the future when Qt version 6 is around. One of the main problems in using the new QJsEngine right now is the missing debugger feature.

Example Scripts

All the planned algorithms were implemented using the script language (Javascript). Some of the data structures implemented were not implemented in the most efficient manner, resulting in different complexities. The implementation of better data structures can be left to the student focusing in learning the algorithms, as it only change the general complexity and not the graph algorithm in itself.

An short explanation and the general time complexity is showed in the beginning of each script, as can be seen in the Script Explanation Example image.

Script Explanation Example

Repository

I have talked with my mentors and we decided that right now is not a good moment to implement a remote repository for the scripts, as the ROCS is still lacking in other more important features that need to be implemented first (see What's Next for some examples).

When the time comes in the future, we can easily implement this features by using GHNS and Open Desktop to host and retrieve files.

Commits

It's is possible to check what was merged and what was not in the following links. All my work can be accessed in the following Merge Requests:

• Self Edges Removal on Transform Edges;
• Improved Examples;
• Improved Dag/Tree Algorithm;
• Improved Graph IDE - Classes;
• Debugger option on script menu.

What's Next?

There are still many things that can be improved in the ROCS software that go out of the scope of my project. Here are some examples:

• Implementation of a better algorithm to position the nodes and edges on the plane. I can recommend the use of Force-directed graph drawing algorithms, because they are usually fast and are physics-based;
• Create a better interface workflow for the program. I can recommend something like the Possible New Configuration image. This configuration consider that the user will spend most part of the time programming, so it creates a better writing space, while the view has a more square shape, which is (in my opinion), better for visualization;
• Remodelation of how each graph is represented in the javascript code. The type system is good to provide a global configuration, but I think it falls apart when dealing with individual edges and dynamic creation of subgraphs and new edges/nodes (which is needed in some algorithms);
• Rewrite the view to deal with some problems related to the space of the graphs that is really limited, mouse clicks not working correctly and bad navigation;
• Change how the icons are used by the ROCS, as some icons don't have cross-compatibility between some systems.

Possible New Configuration

About Me

• Name: Caio Henrique Segawa Tonetti
• Blog: chst.dev
• Mentors: Tomaz Canabrava, Adriaan de Groot
• Email: ​[email protected]
• KDE Invent ID:​ ​https://invent.kde.org/ctonetti
• IRC nickname: ctonetti

Screenshots

• 
  Menu of the Path Graph Creation Tool
• 
  Menu of the Complete Graph Creation Tool
• 
  Menu of the Complete Bipartite Graph Creation Tool
• 
  Detail of the default Edge Types changed
• 
  Detail of the default Edge Types changed
• 
  Final print of the ROCS with modifications