MAINT: Add documentation and descriptive variable names in search.py (aimacode#1142)

tirthasheshpatel · antmarakis · commit 4363ddb135b1 · 2020-01-02T23:55:17.000+02:00
* DOC: Add docstring to __hash__ method in Node

* MAINT: Add documenation and descriptive variable names

* FIXUP: Revert to previos names
diff --git a/search.py b/search.py
@@ -123,6 +123,10 @@ def __eq__(self, other):
         return isinstance(other, Node) and self.state == other.state
 
     def __hash__(self):
+        # We use the hash value of the state
+        # stored in the node instead of the node
+        # object itself to quickly search a node
+        # with the same state in a Hash Table
         return hash(self.state)
 
 
@@ -353,14 +357,16 @@ def extend(U, open_dir, open_other, g_dir, g_other, closed_dir):
 
     def find_min(open_dir, g):
         """Finds minimum priority, g and f values in open_dir"""
-        m, m_f = np.inf, np.inf
+        # pr_min_f isn't forward pr_min instead it's the f-value
+        # of node with priority pr_min.
+        pr_min, pr_min_f = np.inf, np.inf
         for n in open_dir:
             f = g[n] + problem.h(n)
             pr = max(f, 2 * g[n])
-            m = min(m, pr)
-            m_f = min(m_f, f)
+            pr_min = min(pr_min, pr)
+            pr_min_f = min(pr_min_f, f)
 
-        return m, m_f, min(g.values())
+        return pr_min, pr_min_f, min(g.values())
 
     def find_key(pr_min, open_dir, g):
         """Finds key in open_dir with value equal to pr_min
