Commit fb585bae authored by Dennis Hendriks's avatar Dennis Hendriks
Browse files

#344 DSM-related documentation improvements addressing review comments.

parent 3e0ceac5
......@@ -15,7 +15,7 @@ include::_part_attributes.asciidoc[]
include::_local_attributes.asciidoc[]
[[tools-chapter-dsm-clustering]]
=== Design Structure Matrix (DSM) clustering
== Design Structure Matrix (DSM) clustering
indexterm:[DSM clustering]
indexterm:[tools,DSM clustering]
......@@ -33,10 +33,11 @@ indexterm:[DSM clustering,start]
The clustering tool can be started in the following ways:
* In Eclipse, right click a `.dsm` file in the _Project Explorer_ tab or _Package Explorer_ tab and choose menu:Cluster a DSM... .
* In Eclipse, right click a `.dsm` file in the _Project Explorer_ tab or _Package Explorer_ tab and choose menu:Cluster a DSM...[].
* Right click an open text editor for a `.dsm` file and choose menu:Cluster a DSM...[].
* Use the `dsmclustering` tool in a ToolDef script.
See the <<tools-scripting-chapter-intro,scripting documentation>> and <<tools-scripting-chapter-tools,tools overview>> page for details.
* Use the `dsmclustering` command line tool.
......
......@@ -14,7 +14,7 @@
include::_part_attributes.asciidoc[]
[[dsm-algorithm]]
=== Algorithm and code
== Algorithm and code
The algorithm is defined in <<Wilschut2017>>. The link between names of parameters in the algorithm and the code is listed in the <<clustering-function-parameter-table>> table.
......
......@@ -13,11 +13,11 @@
include::_part_attributes.asciidoc[]
[[dsm-busdetection]]
=== Bus detection algorithms
indexterm:[DSM library,busdetection]
[[dsm-busdetection]]
== Bus detection algorithms
The original bus detection mechanism, as introduced in <<wilschut>>, is named the fixed-point
algorithm. When this algorithm is selected, `double busInclusion` corresponds to the parameter
ɣ in the paper.
......
......@@ -14,9 +14,9 @@
include::_part_attributes.asciidoc[]
[[dsm-entrypoint]]
=== Code organization
== Code organization
For a user, the entry point is the `Main.flowBasedMarkovClustering` function which takes the following parameters:
For a user, the entry point is the `DsmClustering.flowBasedMarkovClustering` method which takes the following parameters:
indexterm:[DSM library,Markov clustering parameters]
......
......@@ -20,7 +20,7 @@ One way to find structure in a graph is by seeing it as a collection of _cluster
In addition, in a lot of cases, there is a set of nodes that connect to many other nodes in the graph (or in terms of clusters, one cluster connects with many other clusters).
Such a set of nodes is named a _bus_.
This library documentation describes how to perform such clustering and bus-detection at Java function level.
This library documentation describes how to perform such clustering and bus-detection at Java method level.
indexterm:[DSM library,implementation]
indexterm:[DSM library,java]
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment