tree_handler 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4f84c2af33d9bc188f1d79837dd4131b7d0505d78625c5729a63747eace2d94
-  data.tar.gz: 89e71bc1056c0aa5c5904540dc1c405d80013f7f53b9a204bc09566da027f022
+  metadata.gz: 79d3c24fed8097d3bcfc15df3d0b7afd7d4dcfa965df02e445d438d4304b645c
+  data.tar.gz: df770293c7328d0be9fcee5f357e9900492848003e2fd957bbc5ec7377c3e09c
 SHA512:
-  metadata.gz: 719a4923aad2588a5bf65102bf4643309248dc826177e4125e45fecd60855b062227819a43f221f10d443d44595de4e945a3817edaa205237908bec561c68cee
-  data.tar.gz: 8d5c93d3e4d0721a1e2c58cc582e2629b027c9b14c3cbf004b99c3079aae0336fdac4de500aaac49de03b326daf62be015a13ca18249bcc7eee881d3be493350
+  metadata.gz: e53a26a4f054e86002aaaeffc86b63abe4d74d8fc2f69e4bf751f4a26892deb4092f7d9f3bf9bddbd776e6832bbf3bf23696e147a2e1a7822b21e1a4f309467e
+  data.tar.gz: 6aea9508d5bd129dd2b39bb5bfa6715409951ee07c8026c3780cdd063ad96d9294af98ca9069be435e466961ba1cf6f469792c0eb3e9da340715aca6400ecdd2

data/README.md

@@ -1,8 +1,7 @@
 # TreeHandler
+TreeHandler is a ruby library allowing yourself to discover **binary trees**.
+Build your own data structure and search trough your model with Tree Traversals (in-order, pre-order, post-order and level-order)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tree_handler`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -22,7 +21,88 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Be aware that this library works only without duplicate value.
+
+### Modification methods
+
+start by creating a new tree
+
+```ruby
+my_object = TreeHandler.new(array)
+# @params : an array of integer (duplicate value won't raise error, they are automatically removed)
+# return : the full object with each node
+```
+
+
+You can then modify by inserting or deleting some nodes by value
+
+```ruby
+my_object.insert(value)
+# @params : an integer (an existing value will raise an error)
+# return : The created node or RuntimeError (The same value can't be inserted twice) if value exists already
+```
+```ruby
+my_object.delete(value, parent_pointer = @root)
+# @params1 : an integer
+# @params2 : the node where the search will start. Default value : root of the tree
+# return : The deleted node or nil of value not found
+```
+To check if the tree is balanced (same depth on each child of the root), simply :
+
+```ruby
+my_object.balanced?
+# return : true if balanced
+```
+
+To rebalance the tree, type :
+
+```ruby
+my_object.rebalance!
+# return : the full object with each node
+```
+### Navigation methods
+
+[Tree traversal](https://en.wikipedia.org/wiki/Tree_traversal#Breadth-first_search_/_level_order) is a way to visit each node in your tree.
+
+```ruby
+# preorder search
+	my_object.preorder
+	# return an array of integer
+
+# inorder search
+	my_object.inorder
+	# return an array of integer
+	
+# postorder search
+	my_object.postorder
+	# return an array of integer
+
+# breadth-first search / level order
+	my_object.level_order
+	# return an array of array for each level
+```
+
+Other useful  method
+
+```ruby
+# find node for a certain value
+	my_object.find(integer, start_node = @root)
+	# @params1 : integer, the value of the node desired
+	# @params2 : the node where the search will start. Default value : root of the tree
+	# return the node or nil if not found
+
+# find parent a certain value
+	my_object.find_parent(integer)
+	# @params1 : integer
+	# return the parent's node of the value searched or nil if not found
+# know the depth of your tree
+	my_object.depth(start_node)
+	# @params1 : the node where the search will start. 
+	# return an integer of the tree's height
+```
+
+
+
 
 ## Development
 
@@ -38,3 +118,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/lib/tree_handler.rb

@@ -20,9 +20,13 @@ module TreeHandler
     end
 
     def insert(value)
-      @data.push(value)
-      node = Node.new(value)
-      compare(root, node)
+      unless @data.include? value
+        @data.push(value)
+        node = Node.new(value)
+        compare(root, node)
+      else
+        raise "The same value can't be inserted twice"
+      end
     end
 
     def delete(value, parent_pointer = @root)
@@ -149,4 +153,4 @@ module TreeHandler
       result
     end
   end
-end
+end

data/lib/tree_handler/version.rb

@@ -1,3 +1,3 @@
 module TreeHandler
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tree_handler
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tristan Hörler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-22 00:00:00.000000000 Z
+date: 2020-10-03 00:00:00.000000000 Z
 dependencies: []
 description: Set of functions to create, modify and search in a binary tree from a
   list.
@@ -33,6 +33,7 @@ files:
 - lib/tree_handler/comparable.rb
 - lib/tree_handler/node.rb
 - lib/tree_handler/version.rb
+- tree_handler-0.1.0.gem
 - tree_handler.gemspec
 homepage: https://github.com/Ichenn92/tree_handler
 licenses: