4progress.tex 4.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. \section{Features}\label{sec:features}
  2. The following features are either planned (\planned), under construction (\progress) or done (\done):
  3. \begin{itemize}
  4. \item[\done] Reading a graph from an input file as described in section~\ref{sec:inputFileFormat}.
  5. \item[\done] Creating random graphs for testing purposes.
  6. \begin{itemize}
  7. \item[\done] Saving those randomly created graphs.
  8. \end{itemize}
  9. \item[\done] Drawing a graph with specified node sizes and positions.
  10. \item[\done] Running the node placement algorithm by Brandes and Köpf~\cite{brandes_fast_2001}.
  11. \begin{itemize}
  12. \item[\done] Calculating the conflicts between edges.
  13. \begin{itemize}
  14. \item[\done] Differentiating between dummy nodes and non-dummy nodes.
  15. \end{itemize}
  16. \item[\done] Calculating the blocks.
  17. \item[\done] Compacting the layout.
  18. \item[\done] Combining the layouts.
  19. \end{itemize}
  20. \item[\done] Illustrating the progress while the algorithm is running in the form of
  21. \begin{itemize}
  22. \item[\done] Drawing the nodes at their current position.
  23. \item[\done] Drawing the nodes in the color of their blocks.
  24. \item[\progress] Drawing a colored background to show the class assignments.
  25. \item[\done] Drawing the edges just as plain straight lines.
  26. \item[\done] Drawing the conflicted edges in a different color.
  27. \item[\done] Drawing dummy nodes differently from other nodes.
  28. \item[\done] Drawing the four extremal layouts and the combined layout separately.
  29. \begin{itemize}
  30. \item[\done] Optionally, drawing the only the extremal layout the algorithm is currently working on.
  31. \end{itemize}
  32. \item[\planned] Drawing the edges of the block graph (yet another color, low priority).
  33. \item[\done] Showing pseudocode and the position where the algorithm currently is.
  34. \begin{itemize}
  35. \item[\done] Clicking on the pseudocode to set a breakpoint at (not \reserved{goto}) a specific location.
  36. \item[\done] Customizing the font size of the code.
  37. \end{itemize}
  38. \item[\planned] Showing a legend to explain the shapes and colors.
  39. \item[\done] Showing tooltips when hovering over code lines and nodes in the graph that show the state of the variables.
  40. \item[\done] Hovering the mose over a node to highlight it in all layouts.
  41. \end{itemize}
  42. \item[\done] Running the algorithm step by step manually.
  43. \item[\done] Running the algorithm step by step with configurable delay (\enquote{automatic execution}).
  44. \item[\done] Running the algorithm only on the expanded parts of the source code (\enquote{step overrun}).
  45. \begin{itemize}
  46. \item[\done] Right clicking the code to expand or collapse all lines up to a specified level.
  47. \end{itemize}
  48. \item[\done] Using debugger-like commands such as \enquote{step into}, \enquote{step over}, \enquote{step out}.
  49. \item[\done] Adding buttons and other graphical elements to support the user interface (low priority, see figure~\ref{fig:sketch}).
  50. Currently there is only keyboard input (cf.\ section~\ref{sec:userInterface}).
  51. \begin{itemize}
  52. \item[\done] Displaying the buttons.
  53. \item[\done] Making all the buttons work.
  54. \end{itemize}
  55. \item[\done] Working with hierarchical graphs.
  56. \item[\done] Scaling the display with the (adjustable) window size.
  57. \item[\planned] Working with disconnected graphs (cf.\ section~\ref{sec:assumptions}), either by modifying the algorithm or by processing the connected components one by one (low priority).
  58. \item[\done] Creating ElkNode~\cite{noauthor_elk:_2018} objects from LayeredGraphNode (\ref{sec:graph}) objects.
  59. \item[\planned] Creating LayeredGraphNode (\ref{sec:graph}) objects from ElkNode~\cite{noauthor_elk:_2018} objects (low priority).
  60. \end{itemize}
  61. \section{Known Issues}\label{sec:knownIssues}
  62. The most important unsolved issues are listed here.
  63. For a complete list, see \url{https://koljastrohm-games.com:3000/GraphDrawer/NodeShuffler/issues}.
  64. \begin{itemize}
  65. \item \sout{Our implementation does not behave correctly for very few graphs, see section ~\ref{sec:assumptions} and figures~\ref{fig:error_disconnected_img},~\ref{fig:error_connected_img},~\ref{fig:error_disconnected}, and~\ref{fig:error_connected}.}
  66. We don't know what caused this problem but after a larger rewrite of the algorithm this is fixed, at least for connected graphs.
  67. \item \sout{Swing is not thread-safe, but we are using multiple threads, so every now and then there are race conditions causing mostly \code{ArrayIndexOutOfBoundsException}s and \code{NullPointerException}s.}
  68. Presumably fixed.
  69. \end{itemize}