Top level fn comments/explanations

Author: lee-naish

src/algorithms/pseudocode/AStar.js

@@ -3,12 +3,17 @@ import parse from '../../pseudocode/parse';
 export default parse(`
 \\Code{
     Main
-    Astar(G, s, e) // Given a graph G find a shortest path from start node s \\B 1
-            // to the end node e.  Nodes are numbered 1..nmax. Returns the
-            // Parent array, which gives the previous node in the path from s
-            // to the node i (if one has been found; Parent[i] = 0 otherwise).
-            // A heuristic function is used to guide the search (here it is based
-            // on a measure of the distance from each node to e).
+    Astar(G, s, e) // Heuristic search for node e from node s in graph G \\B 1
+    \\Expl{ Given a graph G, find a path from start node s
+            to the end node e.  Nodes are numbered 1..nmax. Returns the
+            Parent array, which gives the previous node in the path from s
+            to the node i (if one has been found; Parent[i] = 0 otherwise).
+            A heuristic function is used to guide the search (here it is
+            a measure of the distance from each node to e, based on
+            the Euclidiean coordinates of each node). If the
+            heuristic is "admissible", the shortest path will be found.
+    \\Expl}
+
      \\In{
           initialise, with fontier={s}, stored in Nodes \\Ref Init
             while Nodes is not empty \\B 2

src/algorithms/pseudocode/BFS.js

@@ -3,12 +3,14 @@ import parse from '../../pseudocode/parse';
 export default parse(`
 \\Code{
     Main
-    BFS(G, s) // Given a graph G find a path from start node s to an \\B 1
-            // end node.  It is assumed the end node(s) are defined
-            // separately; if there are no end nodes, paths to all connected
-            // nodes are found. Nodes are numbered 1..nmax. Returns the Parent
-            // array, which gives the previous node in the path from s to the
-            // node i (if one has been found; Parent[i] = 0 otherwise).
+    BFS(G, s) // Breadth first search of graph G from start node s \\B 1
+    \\Expl{ Given a graph G, find a path from the start node s to an
+            end node.  It is assumed the end node(s) are defined
+            separately; if there are no end nodes, paths to all connected
+            nodes are found. Nodes are numbered 1..nmax. Returns the Parent
+            array, which gives the previous node in the path from s to the
+            node i (if one has been found; Parent[i] = 0 otherwise).
+    \\Expl}
     \\In{
         initialise, with fontier={s}, stored in Nodes \\Ref Init
         while Nodes is not empty \\B 2

src/algorithms/pseudocode/DFS.js

@@ -3,12 +3,14 @@ import parse from '../../pseudocode/parse';
 export default parse(`
 \\Code{
     Main
-    DFS(G, s) // Given a graph G find a path from start node s to an  \\B 1
-            // end node.  It is assumed the end node(s) are defined
-            // separately; if there are no end nodes, paths to all connected
-            // nodes are found. Nodes are numbered 1..nmax. Returns the Parent
-            // array, which gives the previous node in the path from s to the
-            // node i (if one has been found; Parent[i] = 0 otherwise).
+    DFS(G, s) // Depth first search of graph G from start node s \\B 1
+    \\Expl{ Given a graph G, find a path from the start node s to an
+            end node.  It is assumed the end node(s) are defined
+            separately; if there are no end nodes, paths to all connected
+            nodes are found. Nodes are numbered 1..nmax. Returns the Parent
+            array, which gives the previous node in the path from s to the
+            node i (if one has been found; Parent[i] = 0 otherwise).
+    \\Expl}
     \\In{
         initialise, with fontier={s}, stored in Nodes \\Ref Init
         while Nodes is not empty \\B 2

src/algorithms/pseudocode/DFSrec.js

@@ -26,9 +26,15 @@ made explicit
 
 \\Code{
 Main
-DFS(G, n) // Given a graph G find a path from start node n to a \\B start
-        // separately defined end node; if there are no end nodes, paths
-        // to all connected nodes are found.
+DFS(G, n) // Depth first search of graph G from start node n \\B start
+    \\Expl{ Given a graph G, find a path from the start node n to an
+            end node.  It is assumed the end node(s) are defined
+            separately; if there are no end nodes, paths to all connected
+            nodes are found. Nodes are numbered 1..nmax. Returns the Parent
+            array, which gives the previous node in the path from s to the
+            node i (if one has been found; Parent[i] = 0 otherwise).
+    \\Expl}
+
 \\In{
     initialise all parents to null \\B init
     \\Expl{ We initialise to some special value so we can later check if a

src/algorithms/pseudocode/TTFTreeInsertion.js

@@ -87,8 +87,7 @@ to the page of the file-system.
     
 \\Code{
     Main
-    T234_Insert(t, k) // return either a node containing key k or \\B T234_Insert(t, k)
-                      // NotFound, if no such node is present
+    T234_Insert(t, k) // Insert key k into 234 tree t \\B T234_Insert(t, k)
     \\In{
         if t = Empty \\B if t = Empty
         \\In{
@@ -546,4 +545,4 @@ to the page of the file-system.
     \\In}
     
     \\Note}
-`);
+`);

src/algorithms/pseudocode/dijkstra.js

@@ -3,12 +3,15 @@ import parse from '../../pseudocode/parse';
 export default parse(`
 \\Code{
 Main
-Shortest(G, s) //Given a graph G find a shortest path from start node s \\B 1
-        // to an end node.  It is assumed the end node(s) are defined
-        // separately; with no end nodes, shortest paths to all connected
-        // nodes are found. Nodes are numbered 1..nmax. Returns the Parent
-        // array, which gives the previous node in the path from s to the
-        // node i (if one has been found; Parent[i] = 0 otherwise). 
+Shortest(G, s) // Find shortest path(s) from start node s in graph G \\B 1
+    \\Expl{ Given a graph G, find a shortest path from start node s
+        to an end node.  It is assumed the end node(s) are defined
+        separately; with no end nodes, shortest paths to all connected
+        nodes are found. Nodes are numbered 1..nmax. Returns the Parent
+        array, which gives the previous node in the path from s to the
+        node i (if one has been found; Parent[i] = 0 otherwise). 
+    \\Expl}
+
         \\In{
                 initialise, with fontier={s}, stored in Nodes \\Ref Init
                 while Nodes is not empty \\B 2

src/algorithms/pseudocode/transitiveClosure.js

@@ -3,8 +3,8 @@ import parse from '../../pseudocode/parse';
 export default parse(`
 \\Code{
   Main
-  Warshall(A, n)  \\B 1
-  \\Expl{  Compute the transitive closure of a directed graph G 
+  Warshall(A, n) // Compute the transitive closure of a graph \\B 1
+  \\Expl{  Compute the transitive closure of a directed graph
     with nodes 1..n, represented by n x n adjacency matrix A 
   \\Expl}
   \\In{