Add Tree Traversal in Emojicode

This is a combination of 5 commits.
This is the 1st commit message:

Add Tree Traversal in Emojicode

This is the commit message #2:

Remove unnecessary 🤜🤛.

This was suggested by thbwd:
"No need to wrap 🤜children_count🤛 into 🤜🤛actually."
(https://github.com/algorithm-archivists/algorithm-archive/pull/
471#discussion_r223291032)

This is the commit message #3:

Extract shared logic into a method.

This was suggested by thbwd:
"This is shared logic. I’d recommend you extract it into a method."
(https://github.com/algorithm-archivists/algorithm-archive/pull/
471#discussion_r223291140)

This is the commit message #4:

Use documentation comments.

This was suggested by thbwd:
"Shouldn’t these be documentation comments? https://www.emojicode.org/
docs/reference/documentation.html"
(https://github.com/algorithm-archivists/algorithm-archive/pull/
471#discussion_r223291281)

This is the commit message #5:

Add error as a potential return value for DFS RI Binary

To be able to return an error and to apply suggestion by thbwd
(https://github.com/algorithm-archivists/algorithm-archive/pull/
471#discussion_r223597592) the following changes were made:
- Declare an enum to hold the error value.
- Rewrite the Depth-First Search Recursive Inorder Binary method to
return an optional holding the enum and adjust the returns according
to that.
- Call the rewritten method and check, if the returned optional holds
error. If it does: Print out the error message defined in the enum.

Signed-off-by: Julian Schacher <[email protected]>

Author: june128

contents/tree_traversal/code/emojicode/tree_traversal.emojic

@@ -0,0 +1,143 @@
+🦃 ⏹ 🍇
+  🔘 ⏫
+
+  ❗️ 🔡 ➡️ 🔡 🍇
+    ↪️ 🐕 🙌 🆕⏹⏫❗️ 🍇
+      ↩️ 🔤The given tree is not binary!🔤
+    🍉
+    ↩️ 🔤🔤
+  🍉
+🍉
+
+🐇 🌲 🍇
+  🖍🆕 id 🔢
+  🖍🆕 children 🍨🐚🌲🍆
+
+  🆕 depth_count 🔢 children_count 🔢 🍇
+    1 ➡️ 🖍id
+    🍨🍆 ➡️ 🖍children
+
+    🌌🐕 depth_count children_count❗️
+  🍉
+
+  🔐 🆕 ⭐️ given_id 🔢 depth_count 🔢 children_count 🔢 🍇
+    given_id ➡️ 🖍id
+    🍨🍆 ➡️ 🖍children
+
+    🌌🐕 depth_count children_count❗️
+  🍉
+
+  ❗️ 🆔 ➡️ 🔢 🍇
+    ↩️ id
+  🍉
+
+  ❗️ 🧒 ➡️ 🍨🐚🌲🍆 🍇
+    ↩️ children
+  🍉
+
+  📗 Depth-First Search Recursive pre-order 📗
+  ❗️ 🌀 🍇
+    😀 🔡 id 10❗️❗️
+
+    🔂 child children 🍇
+      🌀 child❗️
+    🍉
+  🍉
+
+  📗 Depth-First Search Recursive post-order 📗
+  ❗️ 🍥 🍇
+    🔂 child children 🍇
+      🍥 child❗️
+    🍉
+
+    😀 🔡 id 10❗️❗️
+  🍉
+
+  📗
+    Depth-First Search Recursive Inorder Binary
+    This assumes only 2 children.
+  📗
+  ❗️ 🍭 ➡️ 🍬⏹ 🍇
+    ↪️ 🐔 children❗️ ▶️ 2 🍇
+      ↩️ 🆕⏹⏫❗️
+    🍉
+
+    ↪️ 🐔 children❗️ ▶️ 0 🍇
+      🍭🐽 children 0❗️❗️
+      😀 🔡 id 10❗️❗️
+      🍭🐽 children 1❗️❗️
+    🍉
+    🙅 🍇
+      😀 🔡 id 10❗️❗️
+    🍉
+    ↩️ 🤷‍♀️
+  🍉
+
+  📗 Depth-First Search Stack 📗
+  ❗️ 🥞 🍇
+    🍨 🐕 🍆 ➡️ stack
+
+    🔁 ❎ 🐔 stack❗️ 🙌  0❗️ 🍇
+      🐽 stack 🐔 stack❗️ ➖ 1❗️ ➡️ temp
+      🐨 stack 🐔 stack❗️ ➖ 1❗️
+
+      😀 🔡 🆔 temp❗️ 10❗️❗️
+
+      🧒 temp❗️ ➡️ temp_children
+      🔂 child temp_children 🍇
+        🐻 stack child❗️
+      🍉
+    🍉
+  🍉
+
+  📗 Breadth-First Search Queue 📗
+  ❗️ 🏢 🍇
+    🍨 🐕 🍆 ➡️ queue
+
+    🔁 ❎ 🐔 queue❗️ 🙌  0❗️ 🍇
+      🐽 queue 0❗️ ➡️ temp
+      🐨 queue 0❗️
+
+      😀 🔡 🆔 temp❗️ 10❗️❗️
+
+      🧒 temp❗️ ➡️ temp_children
+      🔂 child temp_children 🍇
+        🐻 queue child❗️
+      🍉
+    🍉
+  🍉
+
+  🔐 ❗️ 🌌 depth_count 🔢 children_count 🔢 🍇
+    ↪️ ❎ depth_count ◀️🙌 1❗️ 🍇
+      🔂 i 🆕⏩⏩ 0 children_count❗️ 🍇
+        🐻 children 🆕🌲⭐️ 🤜id ✖️ 10 ➕ i ➕ 1🤛 🤜depth_count ➖ 1🤛 children_count❗️❗️
+      🍉
+    🍉
+  🍉
+🍉
+
+🏁 🍇
+  🆕🌲🆕 3 3❗️ ➡️ tree
+  😀 🔤Tree Traversal🔤️❗️
+  😀 🔤🌀  - Depth-First Search Recursive pre-order🔤❗️
+  🌀tree❗️
+  😀 🔤🍥  - Depth-First Search Recursive post-order🔤❗️
+  🍥tree❗️
+  😀 🔤🥞  - Depth-First Search Stack🔤❗️
+  🥞tree❗️
+  😀 🔤🏢  - Breadth-First Search Queue🔤❗️
+  🏢tree❗️
+
+  😀 🔤🍭  - Depth-First Search Recursive Inorder Binary - Error🔤❗️
+  💭 Calling the Depth-First Search Recursive Inorder Binary method here does
+  💭 result in an error, since "tree" is not a binary tree.
+  ️↪️ 🍭tree❗️ ➡️ return 🍇
+    😀 🔡return❗❗️️
+  🍉
+
+  🆕🌲🆕 3 2❗️ ➡️ binary_tree
+  😀 🔤🍭  - Depth-First Search Recursive Inorder Binary🔤❗️
+  ️↪️ 🍭binary_tree❗️ ➡️ return 🍇
+    😀 🔡return❗❗️️
+  🍉
+🍉

contents/tree_traversal/tree_traversal.md

@@ -34,6 +34,8 @@ This has not been implemented in your chosen language, so here is the Julia code
 [import:1-5, lang:"crystal"](code/crystal/tree-traversal.cr)
 {% sample lang="go" %}
 [import:5-8, lang:"golang"](code/golang/treetraversal.go)
+{% sample lang="emojic" %}
+[import:1-3, lang:"emojicode"](code/emojicode/tree_traversal.emojic)
 {% endmethod %}
 
 Because of this, the most straightforward way to traverse the tree might be recursive. This naturally leads us to the Depth-First Search (DFS) method:
@@ -70,6 +72,8 @@ Because of this, the most straightforward way to traverse the tree might be recu
 [import:7-10, lang:"crystal"](code/crystal/tree-traversal.cr)
 {% sample lang="go" %}
 [import:10-15, lang:"golang"](code/golang/treetraversal.go)
+{% sample lang="emojic" %}
+[import:27-34, lang:"emojicode"](code/emojicode/tree_traversal.emojic)
 {% endmethod %}
 
 At least to me, this makes a lot of sense. We fight recursion with recursion! First, we first output the node we are on and then we call `DFS_recursive(...)` on each of its children nodes. This method of tree traversal does what its name implies: it goes to the depths of the tree first before going through the rest of the branches. In this case, the ordering looks like:
@@ -114,6 +118,8 @@ Now, in this case the first element searched through is still the root of the tr
 [import:12-15, lang:"crystal"](code/crystal/tree-traversal.cr)
 {% sample lang="go" %}
 [import:17-22, lang:"golang"](code/golang/treetraversal.go)
+{% sample lang="emojic" %}
+[import:36-43, lang:"emojicode"](code/emojicode/tree_traversal.emojic)
 {% endmethod %}
 
 <p>
@@ -153,6 +159,8 @@ In this case, the first node visited is at the bottom of the tree and moves up t
 [import:17-31, lang:"crystal"](code/crystal/tree-traversal.cr)
 {% sample lang="go" %}
 [import:24-38, lang:"golang"](code/golang/treetraversal.go)
+{% sample lang="emojic" %}
+[import:45-62, lang:"emojicode"](code/emojicode/tree_traversal.emojic)
 {% endmethod %}
 
 <p>
@@ -202,6 +210,8 @@ In code, it looks like this:
 [import:33-41, lang:"crystal"](code/crystal/tree-traversal.cr)
 {% sample lang="go" %}
 [import:40-49, lang:"golang"](code/golang/treetraversal.go)
+{% sample lang="emojic" %}
+[import:64-79, lang:"emojicode"](code/emojicode/tree_traversal.emojic)
 {% endmethod %}
 
 All this said, there are a few details about DFS that might not be idea, depending on the situation. For example, if we use DFS on an incredibly long tree, we will spend a lot of time going further and further down a single branch without searching the rest of the data structure. In addition, it is not the natural way humans would order a tree if asked to number all the nodes from top to bottom. I would argue a more natural traversal order would look something like this:
@@ -243,6 +253,8 @@ And this is exactly what Breadth-First Search (BFS) does! On top of that, it can
 [import:43-51, lang:"crystal"](code/crystal/tree-traversal.cr)
 {% sample lang="go" %}
 [import:51-60, lang:"golang"](code/golang/treetraversal.go)
+{% sample lang="emojic" %}
+[import:81-96, lang:"emojicode"](code/emojicode/tree_traversal.emojic)
 {% endmethod %}
 
 ## Example Code
@@ -286,6 +298,8 @@ The code snippets were taken from this [Scratch project](https://scratch.mit.edu
 [import, lang:"crystal"](code/crystal/tree-traversal.cr)
 {% sample lang="go" %}
 [import, lang:"golang"](code/golang/treetraversal.go)
+{% sample lang="emojic" %}
+[import, lang:"emojicode"](code/emojicode/tree_traversal.emojic)
 {% endmethod %}