From: Maxwell Pirtle <maxwellpirtle@gmail.com>
Date: Mon, 5 Jun 2023 12:17:08 +0000 (+0200)
Subject: Complete missing docs for WakeupTreeNode
X-Git-Tag: v3.34~62^2
X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/3959a22b008b3db13750b10bc76f24e4404155d2

Complete missing docs for WakeupTreeNode
---

diff --git a/src/mc/explo/odpor/WakeupTree.hpp b/src/mc/explo/odpor/WakeupTree.hpp
index ea8cf2959a..59b96c3f31 100644
--- a/src/mc/explo/odpor/WakeupTree.hpp
+++ b/src/mc/explo/odpor/WakeupTree.hpp
@@ -21,7 +21,17 @@ namespace simgrid::mc::odpor {
 /**
  * @brief A single node in a wakeup tree
  *
- * Each node in a wakeup tree contains
+ * Each node in a wakeup tree represents a single step
+ * taken in an extension of the execution represented
+ * by the tree within which the node is contained. That is,
+ * a node in the tree is one step on a "pre-defined"
+ * path forward for some execution sequence. The partial
+ * execution that is implicitly represented by the node
+ * is that formed by taking each step on the (unique)
+ * path in the tree from the root node to this node.
+ * Thus, the tree itself contains all of the paths
+ * that "should be" searched, while each node is
+ * simply a step on each path.
  */
 class WakeupTreeNode {
 private:
@@ -167,7 +177,7 @@ public:
    * @brief Returns the number of *non-empty* entries in the tree, viz. the
    * number of nodes in the tree that have an action mapped to them
    */
-  size_t get_num_entries() const { return !empty() ? (nodes_.size() - 1) : static_cast<size_t>(0); }
+  size_t get_num_entries() const { return not empty() ? (nodes_.size() - 1) : static_cast<size_t>(0); }
 
   /**
    * @brief Returns the number of nodes in the tree, including the root node