From d65e3dbf67137c98dd7c28d0acaf4167bb04f181 Mon Sep 17 00:00:00 2001 From: ClemensBuechner Date: Tue, 9 Jul 2024 14:33:14 +0200 Subject: [PATCH] Update documentation. --- .../search_algorithms/iterated_search.cc | 18 ++++-------------- 1 file changed, 4 insertions(+), 14 deletions(-) diff --git a/src/search/search_algorithms/iterated_search.cc b/src/search/search_algorithms/iterated_search.cc index 8addead747..5755623be2 100644 --- a/src/search/search_algorithms/iterated_search.cc +++ b/src/search/search_algorithms/iterated_search.cc @@ -141,8 +141,10 @@ class IteratedSearchFeature true); add_option( "pass_bound", - "use bound from previous search. The bound is the real cost " - "of the plan found before, regardless of the cost_type parameter.", + "use the bound of iterated search as a bound for its component " + "search algorithms, unless these already have a lower bound set. " + "The iterated search bound is tightened whenever a component finds " + "a cheaper plan.", "true"); add_option( "repeat_last", @@ -183,18 +185,6 @@ class IteratedSearchFeature "(using heuristic predefinition) between iterations, " "the path data (that is, landmark status for each visited state) " "will be saved between iterations."); - document_note( - "Semantics of Search Bounds", - "The definition of our interfaces for search algorithms allow to " - "set bounds for the iterated search and all its component search " - "algorithms individually. We do not see a reasonable use case " - "where setting a bound for a component search algorithm is " - "advisable. If this is done anyways, the bound of said search " - "iteration is set to the minimum of that bound and the overall " - "bound on the iterated search. This can be particularly relevant " - "when the option `pass_bound` is set to true in which case the " - "bound of the iterated search is updated whenever a better " - "solution is found by one of its components."); } virtual shared_ptr create_component(const plugins::Options &options, const utils::Context &context) const override {