moved algorithm desc to algo files

Author: Shawn Toubeau

src/algos.ts

@@ -118,4 +118,17 @@ const runAstar = (props: Props) => {
   }, 100 / currentSpeed);
 };
 
-export default runAstar;
+const aStarDesc =
+  " ### A* Info\
+    \nA* pronounced A-Star was originally created in an attempt to create a general purpose robot as part of the Shakey\
+     project in the 1960’s and 70’s. A* is a best-first search algorithm.\
+     \n### Runtime: \
+    \nThe time complexity is polynomial when the search space is a tree, there is a single goal state,\
+     and the heuristic function h meets the following condition:\
+    \n| h ( x ) − h ∗ ( x ) | = O ( log ⁡ h ∗ ( x ) ) \
+    \nwhere h* is the optimal heuristic, the exact cost to get from x to the goal.\
+    \n### Helpful links:\
+    \n[The Coding Train (video part1)] (https://www.youtube.com/watch?v=aKYlikFAV4k&t=968s) \
+    \n[Computerphile (video)] (https://www.youtube.com/watch?v=ySN5Wnu88nE )";
+
+export { runAstar, aStarDesc };

src/components/Maze/algorithms/A*.ts

@@ -70,4 +70,14 @@ const runBFS = (props: Props) => {
   return;
 };
 
-export default runBFS;
+const bfsDesc =
+  "### BFS Info\
+\nBreadth-First Search is a graph or tree traversing algorithm that looks at all nodes at the current level \
+before moving onto the next deepest set of nodes. It was created by Konrad Zuse in 1945 and later reinvented by Edward F. Moore in 1959. \
+\n### Runtime:\
+\nO( | V | + | E |) where V is the number of nodes and E the number of edges.\
+\n### Helpful links: \
+\n[TheHippieCat (video)] (https://www.youtube.com/watch?v=WvR9voi0y2I)\
+\n[Nesbox (README)] (https://github.com/nesbox/TIC-80/wiki/Pathfinding%EA%9E%89-BFS-Algorithm)";
+
+export { runBFS, bfsDesc };

src/components/Maze/algorithms/BFS.ts

@@ -67,4 +67,14 @@ const runDFS = (props: Props) => {
   }, 100 / currentSpeed);
 };
 
-export default runDFS;
+const dfsDesc =
+  "### DFS Info\
+\nDepth-first search is a pathfinding or tree spanning algorithm that follows one branch to its deepest point before backtracking. \
+It was created in the 19th century by French mathematician Charles Pierre Trémaux. \
+\n### Runtime:\
+\nO( | V | + | E |) where V is the number of nodes and E the number of edges.\
+\n### Helpful links:\
+\n[Brilliant (articel)] (https://brilliant.org/wiki/depth-first-search-dfs)\
+\n[Go GATE IIT (video)](https://www.youtube.com/watch?v=iaBEKo5sM7w)";
+
+export { runDFS, dfsDesc };

src/components/Maze/algorithms/DFS.ts

@@ -96,4 +96,15 @@ const runDjikstras = (props: Props) => {
   }, 100 / currentSpeed);
 };
 
-export default runDjikstras;
+const djikstrasDesc =
+  "### Djikstra's Algorithm Info\
+        \nDjikstra's shortest path first Algorithm is a pathfinding algorithm created by Edsger W. Djikstra in 1956. \
+        It uses a min-priority queue to find the shortest path of a weighted graph. \
+        \n### Runtime: \
+        \n(Min-priority queue) O(| V | +| E |log| V |) (where | V | s the number of nodes and | E | is the number of edges)\
+        \n(Array) O(V^2)\
+        \n### Helpful links:\
+        \n[Computerphile (video)](https://www.youtube.com/watch?v=GazC3A4OQTE)\
+        \n[Clément Mihailescu (video)] (https://www.youtube.com/watch?v=msttfIHHkak&t=2826s)";
+
+export { runDjikstras, djikstrasDesc };

src/components/Maze/algorithms/Djikstras.ts

@@ -1,8 +1,8 @@
 import _ from "lodash";
-import runBFS from "./BFS";
-import runDFS from "./DFS";
-import runAstar from "./A*";
-import runDjikstras from "./Djikstras";
+import { runBFS, bfsDesc } from "./BFS";
+import { runDFS, dfsDesc } from "./DFS";
+import { runAstar, aStarDesc } from "./A*";
+import { runDjikstras, djikstrasDesc } from "./Djikstras";
 import { Coord, MazeInfo } from "../../../models/maze";
 import { SpaceTypes } from "../../Space/types";
 import { getMazeSize } from "../Maze";
@@ -159,4 +159,8 @@ export {
   getLowestFScore,
   getValidNeighbors,
   removeFromArr,
+  aStarDesc,
+  bfsDesc,
+  dfsDesc,
+  djikstrasDesc,
 };

src/components/Maze/algorithms/index.ts

@@ -23,8 +23,9 @@ import * as yup from "yup";
 import { Maze } from "../../models/maze";
 import { SpaceTypes } from "../Space/types";
 import { Algorithms } from "../Maze/algorithms/types";
-import algos from "../../algos";
 import { getMazeSize } from "../Maze/Maze";
+// Algorithm information
+import { aStarDesc, bfsDesc, dfsDesc, djikstrasDesc } from "../Maze/algorithms";
 
 import "./Menu.scss";
 
@@ -228,13 +229,13 @@ class MenuBar extends React.Component<MenuProps, _MenuState> {
     if (al === null) {
       al = "Select an algorithm";
     } else if (al === Algorithms.astar) {
-      al = algos.a;
+      al = aStarDesc;
     } else if (al === Algorithms.bfs) {
-      al = algos.BFS;
+      al = bfsDesc;
     } else if (al === Algorithms.dfs) {
-      al = algos.DFS;
+      al = dfsDesc;
     } else if (al === Algorithms.djikstras) {
-      al = algos.Djikstras;
+      al = djikstrasDesc;
     }
     return al as string;
   };