Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
ClemensBuechner committed Jul 10, 2024
1 parent cf95dc5 commit d65e3db
Showing 1 changed file with 4 additions and 14 deletions.
18 changes: 4 additions & 14 deletions src/search/search_algorithms/iterated_search.cc
Original file line number Diff line number Diff line change
Expand Up @@ -141,8 +141,10 @@ class IteratedSearchFeature
true);
add_option<bool>(
"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<bool>(
"repeat_last",
Expand Down Expand Up @@ -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<IteratedSearch> create_component(const plugins::Options &options, const utils::Context &context) const override {
Expand Down

0 comments on commit d65e3db

Please sign in to comment.