Skip to content

Commit 7f47cc0

Browse files
authored
Merge pull request #6573 from IoannisPanagiotas/steiner-forgot-delta
[Steiner] Two minors in docs
2 parents 319c127 + a11ff86 commit 7f47cc0

File tree

3 files changed

+7
-2
lines changed

3 files changed

+7
-2
lines changed

doc/modules/ROOT/pages/algorithms/directed-steiner-tree.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,11 @@ It is also possible to try and augment the solution discovered by the heuristic
415415
This option can be enabled by setting `applyRerouting:true` in the configuration.
416416

417417
The rerouting phase re-examines the relationships in the discovered steiner tree and tries to reroute nodes (that is change their parent with another node in the tree) so as to decrease the cost.
418-
The rerouting phase might even have as an effect that some nodes are removed for a tree.
418+
After the rerouting phase some nodes might end up being childless, that is not part of any path between the source and a target.
419+
Such nodes are then removed from the returned solution.
420+
421+
Note that there is no guarantee that enabling rerouting will always lead to an improvement in quality.
422+
419423

420424
[role=query-example]
421425
--

doc/modules/ROOT/partials/algorithms/shortest-path/path-syntax.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ ifeval::["{algorithm}" == "Yen's"]
4343
| k | Integer | 1 | yes | The number of shortest paths to compute between source and target node.
4444
endif::[]
4545
ifeval::["{algorithm}" == "Delta-Stepping"]
46-
| delta | Float | 2 | yes | The bucket width for grouping nodes with the same tentative distance to the source node.
46+
| delta | Float | 2.0 | yes | The bucket width for grouping nodes with the same tentative distance to the source node.
4747
endif::[]
4848
| xref:common-usage/running-algos.adoc#common-configuration-relationship-weight-property[relationshipWeightProperty] | String | null | yes | Name of the relationship property to use as weights. If unspecified, the algorithm runs unweighted.
4949
|===
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
| sourceNode | Integer | null | n/a | The starting source node ID.
22
| targetNodes | List of Integer | null | n/a | The list of target nodes
33
| xref:common-usage/running-algos.adoc#common-configuration-relationship-weight-property[relationshipWeightProperty] | String | null | yes | Name of the relationship property to use as weights. If unspecified, the algorithm runs unweighted.
4+
| delta | Float | 2.0 | yes | The bucket width for grouping nodes with the same tentative distance to the source node. Look into the xref:algorithms/delta-single-source.adoc[Delta-Stepping] documentation for more information.
45
| applyRerouting | boolean | false | yes | If specified, the algorithm will try to improve the outcome via an additional post-processing heuristic.

0 commit comments

Comments
 (0)