From d5764032778bd0623dc69a6313f2689c2dee6c0a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Fernandes?= Date: Fri, 28 Jun 2024 10:00:33 -0300 Subject: [PATCH] [gleam] complete binary-search-tree --- gleam/binary-search-tree/.gitignore | 4 + gleam/binary-search-tree/HELP.md | 32 ++++++++ gleam/binary-search-tree/README.md | 62 ++++++++++++++ gleam/binary-search-tree/gleam.toml | 12 +++ gleam/binary-search-tree/manifest.toml | 27 +++++++ .../src/binary_search_tree.gleam | 33 ++++++++ .../test/binary_search_tree_test.gleam | 81 +++++++++++++++++++ 7 files changed, 251 insertions(+) create mode 100644 gleam/binary-search-tree/.gitignore create mode 100644 gleam/binary-search-tree/HELP.md create mode 100644 gleam/binary-search-tree/README.md create mode 100644 gleam/binary-search-tree/gleam.toml create mode 100644 gleam/binary-search-tree/manifest.toml create mode 100644 gleam/binary-search-tree/src/binary_search_tree.gleam create mode 100644 gleam/binary-search-tree/test/binary_search_tree_test.gleam diff --git a/gleam/binary-search-tree/.gitignore b/gleam/binary-search-tree/.gitignore new file mode 100644 index 0000000..170cca9 --- /dev/null +++ b/gleam/binary-search-tree/.gitignore @@ -0,0 +1,4 @@ +*.beam +*.ez +build +erl_crash.dump diff --git a/gleam/binary-search-tree/HELP.md b/gleam/binary-search-tree/HELP.md new file mode 100644 index 0000000..498a988 --- /dev/null +++ b/gleam/binary-search-tree/HELP.md @@ -0,0 +1,32 @@ +# Help + +## Running the tests + +To run the tests, run the command `gleam test` from within the exercise directory. + +## Submitting your solution + +You can submit your solution using the `exercism submit src/binary_search_tree.gleam` command. +This command will upload your solution to the Exercism website and print the solution page's URL. + +It's possible to submit an incomplete solution which allows you to: + +- See how others have completed the exercise +- Request help from a mentor + +## Need to get help? + +If you'd like help solving the exercise, check the following pages: + +- The [Gleam track's documentation](https://exercism.org/docs/tracks/gleam) +- The [Gleam track's programming category on the forum](https://forum.exercism.org/c/programming/gleam) +- [Exercism's programming category on the forum](https://forum.exercism.org/c/programming/5) +- The [Frequently Asked Questions](https://exercism.org/docs/using/faqs) + +Should those resources not suffice, you could submit your (incomplete) solution to request mentoring. + +To get help if you're having trouble, you can use one of the following resources: + +- [gleam.run](https://gleam.run/documentation/) is the gleam official documentation. +- [Discord](https://discord.gg/Fm8Pwmy) is the discord channel. +- [StackOverflow](https://stackoverflow.com/questions/tagged/gleam) can be used to search for your problem and see if it has been answered already. You can also ask and answer questions. \ No newline at end of file diff --git a/gleam/binary-search-tree/README.md b/gleam/binary-search-tree/README.md new file mode 100644 index 0000000..090a095 --- /dev/null +++ b/gleam/binary-search-tree/README.md @@ -0,0 +1,62 @@ +# Binary Search Tree + +Welcome to Binary Search Tree on Exercism's Gleam Track. +If you need help running the tests or submitting your code, check out `HELP.md`. + +## Instructions + +Insert and search for numbers in a binary tree. + +When we need to represent sorted data, an array does not make a good data structure. + +Say we have the array `[1, 3, 4, 5]`, and we add 2 to it so it becomes `[1, 3, 4, 5, 2]`. +Now we must sort the entire array again! +We can improve on this by realizing that we only need to make space for the new item `[1, nil, 3, 4, 5]`, and then adding the item in the space we added. +But this still requires us to shift many elements down by one. + +Binary Search Trees, however, can operate on sorted data much more efficiently. + +A binary search tree consists of a series of connected nodes. +Each node contains a piece of data (e.g. the number 3), a variable named `left`, and a variable named `right`. +The `left` and `right` variables point at `nil`, or other nodes. +Since these other nodes in turn have other nodes beneath them, we say that the left and right variables are pointing at subtrees. +All data in the left subtree is less than or equal to the current node's data, and all data in the right subtree is greater than the current node's data. + +For example, if we had a node containing the data 4, and we added the data 2, our tree would look like this: + + 4 + / + 2 + +If we then added 6, it would look like this: + + 4 + / \ + 2 6 + +If we then added 3, it would look like this + + 4 + / \ + 2 6 + \ + 3 + +And if we then added 1, 5, and 7, it would look like this + + 4 + / \ + / \ + 2 6 + / \ / \ + 1 3 5 7 + +## Source + +### Created by + +- @jiegillet + +### Based on + +Josh Cheek \ No newline at end of file diff --git a/gleam/binary-search-tree/gleam.toml b/gleam/binary-search-tree/gleam.toml new file mode 100644 index 0000000..3b00dcc --- /dev/null +++ b/gleam/binary-search-tree/gleam.toml @@ -0,0 +1,12 @@ +name = "binary_search_tree" +version = "0.1.0" + +[dependencies] +gleam_bitwise = "~> 1.2" +gleam_otp = "~> 0.7 or ~> 1.0" +gleam_stdlib = "~> 0.32 or ~> 1.0" +simplifile = "~> 1.0" +gleam_erlang = ">= 0.25.0 and < 1.0.0" + +[dev-dependencies] +exercism_test_runner = "~> 1.4" diff --git a/gleam/binary-search-tree/manifest.toml b/gleam/binary-search-tree/manifest.toml new file mode 100644 index 0000000..072155d --- /dev/null +++ b/gleam/binary-search-tree/manifest.toml @@ -0,0 +1,27 @@ +# This file was generated by Gleam +# You typically do not need to edit this file + +packages = [ + { name = "argv", version = "1.0.1", build_tools = ["gleam"], requirements = [], otp_app = "argv", source = "hex", outer_checksum = "A6E9009E50BBE863EB37D963E4315398D41A3D87D0075480FC244125808F964A" }, + { name = "exercism_test_runner", version = "1.7.0", build_tools = ["gleam"], requirements = ["argv", "gap", "glance", "gleam_community_ansi", "gleam_erlang", "gleam_json", "gleam_stdlib", "simplifile"], otp_app = "exercism_test_runner", source = "hex", outer_checksum = "2FC1BADB19BEC2AE77BFD2D3A606A014C85412A7B874CAFC4BA8CF04B0B257CD" }, + { name = "gap", version = "1.1.0", build_tools = ["gleam"], requirements = ["gleam_community_ansi", "gleam_stdlib"], otp_app = "gap", source = "hex", outer_checksum = "2EE1B0A17E85CF73A0C1D29DA315A2699117A8F549C8E8D89FA8261BE41EDEB1" }, + { name = "glance", version = "0.8.2", build_tools = ["gleam"], requirements = ["gleam_stdlib", "glexer"], otp_app = "glance", source = "hex", outer_checksum = "ACF09457E8B564AD7A0D823DAFDD326F58263C01ACB0D432A9BEFDEDD1DA8E73" }, + { name = "gleam_bitwise", version = "1.3.1", build_tools = ["gleam"], requirements = [], otp_app = "gleam_bitwise", source = "hex", outer_checksum = "B36E1D3188D7F594C7FD4F43D0D2CE17561DE896202017548578B16FE1FE9EFC" }, + { name = "gleam_community_ansi", version = "1.4.0", build_tools = ["gleam"], requirements = ["gleam_community_colour", "gleam_stdlib"], otp_app = "gleam_community_ansi", source = "hex", outer_checksum = "FE79E08BF97009729259B6357EC058315B6FBB916FAD1C2FF9355115FEB0D3A4" }, + { name = "gleam_community_colour", version = "1.3.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_community_colour", source = "hex", outer_checksum = "A49A5E3AE8B637A5ACBA80ECB9B1AFE89FD3D5351FF6410A42B84F666D40D7D5" }, + { name = "gleam_erlang", version = "0.25.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_erlang", source = "hex", outer_checksum = "054D571A7092D2A9727B3E5D183B7507DAB0DA41556EC9133606F09C15497373" }, + { name = "gleam_json", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib", "thoas"], otp_app = "gleam_json", source = "hex", outer_checksum = "8B197DD5D578EA6AC2C0D4BDC634C71A5BCA8E7DB5F47091C263ECB411A60DF3" }, + { name = "gleam_otp", version = "0.10.0", build_tools = ["gleam"], requirements = ["gleam_erlang", "gleam_stdlib"], otp_app = "gleam_otp", source = "hex", outer_checksum = "0B04FE915ACECE539B317F9652CAADBBC0F000184D586AAAF2D94C100945D72B" }, + { name = "gleam_stdlib", version = "0.36.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "C0D14D807FEC6F8A08A7C9EF8DFDE6AE5C10E40E21325B2B29365965D82EB3D4" }, + { name = "glexer", version = "0.7.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "glexer", source = "hex", outer_checksum = "4484942A465482A0A100936E1E5F12314DB4B5AC0D87575A7B9E9062090B96BE" }, + { name = "simplifile", version = "1.5.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "simplifile", source = "hex", outer_checksum = "EB9AA8E65E5C1E3E0FDCFC81BC363FD433CB122D7D062750FFDF24DE4AC40116" }, + { name = "thoas", version = "0.4.1", build_tools = ["rebar3"], requirements = [], otp_app = "thoas", source = "hex", outer_checksum = "4918D50026C073C4AB1388437132C77A6F6F7C8AC43C60C13758CC0ADCE2134E" }, +] + +[requirements] +exercism_test_runner = { version = "~> 1.4" } +gleam_bitwise = { version = "~> 1.2" } +gleam_erlang = { version = ">= 0.25.0 and < 1.0.0"} +gleam_otp = { version = "~> 0.7 or ~> 1.0" } +gleam_stdlib = { version = "~> 0.32 or ~> 1.0" } +simplifile = { version = "~> 1.0" } diff --git a/gleam/binary-search-tree/src/binary_search_tree.gleam b/gleam/binary-search-tree/src/binary_search_tree.gleam new file mode 100644 index 0000000..59036f2 --- /dev/null +++ b/gleam/binary-search-tree/src/binary_search_tree.gleam @@ -0,0 +1,33 @@ +import gleam/list + +pub type Tree { + Nil + Node(data: Int, left: Tree, right: Tree) +} + +pub fn to_tree(data: List(Int)) -> Tree { + list.fold(data, Nil, insert) +} + +pub fn sorted_data(data: List(Int)) -> List(Int) { + sorting_tree(to_tree(data)) +} + +fn insert(tree: Tree, num: Int) { + case tree { + Nil -> Node(num, Nil, Nil) + Node(data, left, right) -> + case num <= data { + True -> Node(data, insert(left, num), right) + False -> Node(data, left, insert(right, num)) + } + } +} + +fn sorting_tree(input: Tree) { + case input { + Nil -> [] + Node(data, left, right) -> + list.concat([sorting_tree(left), [data], sorting_tree(right)]) + } +} diff --git a/gleam/binary-search-tree/test/binary_search_tree_test.gleam b/gleam/binary-search-tree/test/binary_search_tree_test.gleam new file mode 100644 index 0000000..19bcc26 --- /dev/null +++ b/gleam/binary-search-tree/test/binary_search_tree_test.gleam @@ -0,0 +1,81 @@ +import binary_search_tree.{Nil, Node} +import exercism/should +import exercism/test_runner + +pub fn main() { + test_runner.main() +} + +pub fn data_is_retained_test() { + binary_search_tree.to_tree([4]) + |> should.equal(Node(data: 4, left: Nil, right: Nil)) +} + +pub fn insert_data_at_proper_node_smaller_number_at_left_node_test() { + binary_search_tree.to_tree([4, 2]) + |> should.equal(Node( + data: 4, + left: Node(data: 2, left: Nil, right: Nil), + right: Nil, + )) +} + +pub fn insert_data_at_proper_node_same_number_at_left_node_test() { + binary_search_tree.to_tree([4, 4]) + |> should.equal(Node( + data: 4, + left: Node(data: 4, left: Nil, right: Nil), + right: Nil, + )) +} + +pub fn insert_data_at_proper_node_greater_number_at_right_node_test() { + binary_search_tree.to_tree([4, 5]) + |> should.equal(Node( + data: 4, + left: Nil, + right: Node(data: 5, left: Nil, right: Nil), + )) +} + +pub fn can_create_complex_tree_test() { + binary_search_tree.to_tree([4, 2, 6, 1, 3, 5, 7]) + |> should.equal(Node( + data: 4, + left: Node( + data: 2, + left: Node(data: 1, left: Nil, right: Nil), + right: Node(data: 3, left: Nil, right: Nil), + ), + right: Node( + data: 6, + left: Node(data: 5, left: Nil, right: Nil), + right: Node(data: 7, left: Nil, right: Nil), + ), + )) +} + +pub fn can_sort_data_can_sort_single_number_test() { + binary_search_tree.sorted_data([2]) + |> should.equal([2]) +} + +pub fn can_sort_data_can_sort_if_second_number_is_smaller_than_first_test() { + binary_search_tree.sorted_data([2, 1]) + |> should.equal([1, 2]) +} + +pub fn can_sort_data_can_sort_if_second_number_is_same_as_first_test() { + binary_search_tree.sorted_data([2, 2]) + |> should.equal([2, 2]) +} + +pub fn can_sort_data_can_sort_if_second_number_is_greater_than_first_test() { + binary_search_tree.sorted_data([2, 3]) + |> should.equal([2, 3]) +} + +pub fn can_sort_data_can_sort_complex_tree_test() { + binary_search_tree.sorted_data([2, 1, 3, 6, 7, 5]) + |> should.equal([1, 2, 3, 5, 6, 7]) +}