From 228db3f1de5f91db39e8a2f73de9e977aaf71891 Mon Sep 17 00:00:00 2001
From: ClemensBuechner <clemens.buechner@unibas.ch>
Date: Mon, 22 Jan 2024 11:34:23 +0100
Subject: [PATCH] Add document note.

---
 src/search/search_algorithms/iterated_search.cc | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/src/search/search_algorithms/iterated_search.cc b/src/search/search_algorithms/iterated_search.cc
index 91be629a5b..072f5376f4 100644
--- a/src/search/search_algorithms/iterated_search.cc
+++ b/src/search/search_algorithms/iterated_search.cc
@@ -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 {