Skip to content

Commit

Permalink
Add document note.
Browse files Browse the repository at this point in the history
  • Loading branch information
ClemensBuechner committed Jan 22, 2024
1 parent d0a9b4c commit 228db3f
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions src/search/search_algorithms/iterated_search.cc
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,18 @@ class IteratedSearchFeature : public plugins::TypedFeature<SearchAlgorithm, Iter
"(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 228db3f

Please sign in to comment.