Wiki source code of KLay Layered
Last modified by Richard Kreissig on 2023/09/14 09:07
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | In this tutorial you'll learn about the structure and philosophy in our main layout algorithm [[doc:KIELER.KLay Layered]]. It is based on an idea that became known as //Sugiyama-style// layout, where the task to layout a graph is split into multiple subsequent steps with the goal to emphasize direction, i.e. let as many edges point into the same direction as possible. | ||
| 2 | |||
| 3 | = Preliminaries = | ||
| 4 | |||
| 5 | [[doc:KIELER.Development.Tutorials.Other.Installing Eclipse for Layout Development.WebHome]] | ||
| 6 | |||
| 7 | |||
| 8 | |||
| 9 | == Getting the Source Code == | ||
| 10 | |||
| 11 | Additionally, we need to get our hands on the actual source code of KLay Layered. You can find it in the //pragmatics// repository in our Stash. | ||
| 12 | |||
| 13 | 1. Clone the [[repository>>url:http://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/pragmatics/browse||shape="rect"]]. | ||
| 14 | 1. Import the {{code language="none"}}de.cau.cs.kieler.klay.layered{{/code}} plugin into your workspace. | ||
| 15 | |||
| 16 | = Getting to Know KLay Layered = | ||
| 17 | |||
| 18 | 1. Familiarize yourself with the general idea and architecture of the layout algorithm by reading its [[documentation>>doc:KIELER.KLay Layered]]. You should know about terms like //dummy nodes//, //intermediate processors//, and //phases//. | ||
| 19 | 1. With this knowledge, browse the code and try to identify the packages and classes that relate to the phases of KLay Layered. | ||
| 20 | 1. Understand the differences between the {{code language="none"}}KGraph{{/code}} and {{code language="none"}}LGraph{{/code}} and explore how to use the {{code language="none"}}LGraph{{/code}}. As noted in KLay Layered's documentation the {{code language="none"}}LGraph{{/code}} is a lightweight version that is specifically tailored to serve as a data structure for layer-based layout. The following class diagram contains just about all the information you require for the assignment. | ||
| 21 | [[image:attach:lgraph.png]] | ||
| 22 | |||
| 23 | = Assignment = | ||
| 24 | |||
| 25 | The goal of this assignment is to write a very simple layering algorithm. As you probably already know, classically the layering phase (phase 2) expects the input graph to be acyclic. Here however, you will: | ||
| 26 | |||
| 27 | 1. Configure the layout algorithm to use a {{code language="none"}}NullPhase{{/code}} for cycle breaking, | ||
| 28 | 1. Layer the possibly cyclic graph in a fashion as you like, and | ||
| 29 | 1. Use an intermediate processor to reverse edges (if required) such that subsequent phases are guaranteed to work with an acyclic graph. | ||
| 30 | |||
| 31 | Don't hesitate to switch between the tasks and don't be afraid of exceptions or errors during debugging. When you use your layering phase without the intermediate processors the rest of KLay Layered will most likely complain (for cyclic input graphs). In other words, the following two assignments only work combined and not alone. | ||
| 32 | |||
| 33 | Assignment (a) | ||
| 34 | Create a layout phase called | ||
| 35 | |||
| 36 | {{code language="none"}} | ||
| 37 | NullPhase | ||
| 38 | {{/code}} | ||
| 39 | |||
| 40 | that does nothing and can be used as a cycle breaking strategy. Hint: It has to implement the | ||
| 41 | |||
| 42 | {{code language="none"}} | ||
| 43 | ILayoutPhase | ||
| 44 | {{/code}} | ||
| 45 | |||
| 46 | interface and has to be added to the | ||
| 47 | |||
| 48 | {{code language="none"}} | ||
| 49 | CycleBreakingStrategy | ||
| 50 | {{/code}} | ||
| 51 | |||
| 52 | enumeration. | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | Assignment (b) | ||
| 57 | |||
| 58 | Write an intermediate processor that takes a //layered// graph (i.e. the result of assigment 2) as input and reverses edges such that the output graph is acyclic. Here are some hints. | ||
| 59 | |||
| 60 | The {{code language="none"}}LEdge{{/code}} offers a method {{code language="none"}}reverseEdge{{/code}} that does parts of the job for you and marks the edge such that the {{code language="none"}}ReversedEdgeRestorer {{/code}}will take care of 'back'-reversing the edge at the end of the algorithm. Your class should extend the {{code language="none"}}ILayoutProcessor{{/code}} interface. | ||
| 61 | |||
| 62 | {{code linenumbers="true" language="java"}} | ||
| 63 | public class EdgeDirectionEnforcer implements ILayoutProcessor { | ||
| 64 | @Override | ||
| 65 | public void process(final LGraph layeredGraph, final IKielerProgressMonitor progressMonitor) { | ||
| 66 | // for all edges ... | ||
| 67 | if (...) { | ||
| 68 | edge.reverse(layeredGraph, true); | ||
| 69 | } | ||
| 70 | } | ||
| 71 | } | ||
| 72 | {{/code}} | ||
| 73 | |||
| 74 | Assignment (c) | ||
| 75 | |||
| 76 | Write a layer assignment algorithm that assigns nodes of a possibly cyclic input graph to layers. The only requirement is that you don't assign layers randomly. | ||
| 77 | |||
| 78 | The intermediate processing configuration has to include your previously created intermediate processor as well as the existing {{code language="none"}}ReversedEdgeRestorer{{/code}}. The {{code language="none"}}IntermediateProcessorStrategy{{/code}} can help you to find the phase after which to execute the {{code language="none"}}ReversedEdgeRestorer{{/code}}. | ||
| 79 | |||
| 80 | Take care not to place two nodes in the same layer if they are connected by an edge. | ||
| 81 | |||
| 82 | {{code linenumbers="true" language="java"}} | ||
| 83 | public class RandomLayerer implements ILayoutPhase { | ||
| 84 | @Override | ||
| 85 | public IntermediateProcessingConfiguration getIntermediateProcessingConfiguration(final LGraph graph) { | ||
| 86 | return IntermediateProcessingConfiguration.createEmpty() | ||
| 87 | [ ... ] // add your desired configuration here | ||
| 88 | ; | ||
| 89 | } | ||
| 90 | |||
| 91 | @Override | ||
| 92 | public void process(final LGraph layeredGraph, final IKielerProgressMonitor progressMonitor) { | ||
| 93 | [ ... ] | ||
| 94 | } | ||
| 95 | } | ||
| 96 | {{/code}} | ||
| 97 | |||
| 98 | {{info}} | ||
| 99 | Use {{code language="none"}}node.setLayer(layerX);{{/code}} to add assign a layer to a node. Internally, the node will be added to the layer's list of nodes. | ||
| 100 | |||
| 101 | Don't forget to let the switch statements in the {{code language="none"}}LayeringStrategy{{/code}} and {{code language="none"}}IntermediateProcessorStrategy{{/code}} enumerations know about the new classes. | ||
| 102 | |||
| 103 | The layout options you definitely need are {{code language="none"}}de.cau.cs.kieler.klay.layered.cycleBreaking{{/code}} and {{code language="none"}}de.cau.cs.kieler.klay.layered.nodePlace{{/code}}. | ||
| 104 | {{/info}} | ||
| 105 | |||
| 106 | A result might look like this. The default strategies of KLay Layered try to achieve short edges and a low number of reversed edges. The left screenshot shows the result of a random layerer and is obviously inferior to the result seen in the right screenshot. | ||
| 107 | |||
| 108 | |||
| 109 | [[image:attach:rand.jpg]][[image:attach:klay.jpg]] |