add toArray method to HashTable

Author: doganoo

src/Datastructure/Table/HashTable.php

@@ -83,6 +83,7 @@ private function initializeBucket() {
      * adds a node to the hash map
      *
      * @param Node $node
+     *
      * @return bool
      * @throws InvalidKeyTypeException
      * @throws UnsupportedKeyTypeException
@@ -98,6 +99,7 @@ public function addNode(Node $node): bool {
      *
      * @param $key
      * @param $value
+     *
      * @return bool
      * @throws InvalidKeyTypeException
      * @throws UnsupportedKeyTypeException
@@ -128,6 +130,7 @@ public function add($key, $value): bool {
      * Solution: use universal hashing
      *
      * @param $key
+     *
      * @return int
      * @throws InvalidKeyTypeException
      * @throws UnsupportedKeyTypeException
@@ -150,6 +153,7 @@ private function getBucketIndex($key) {
      * bucket index.
      *
      * @param $key
+     *
      * @return int
      * @throws InvalidKeyTypeException
      * @throws UnsupportedKeyTypeException
@@ -163,6 +167,7 @@ private function getHash($key): int {
      * calculates the bucket index for a given hash
      *
      * @param int $hash
+     *
      * @return int
      */
     private function getArrayIndex(int $hash): int {
@@ -175,6 +180,7 @@ private function getArrayIndex(int $hash): int {
      *
      * @param $key
      * @param $value
+     *
      * @return bool
      * @throws InvalidKeyTypeException
      * @throws UnsupportedKeyTypeException
@@ -183,44 +189,6 @@ public function put($key, $value): bool {
         return $this->add($key, $value);
     }
 
-    /**
-     * @param $key
-     * @return mixed|null
-     * @throws InvalidKeyTypeException
-     * @throws UnsupportedKeyTypeException
-     */
-    public function get($key) {
-        $node = $this->getNodeByKey($key);
-        if (null === $node) return null;
-        return $node->getValue();
-    }
-
-    /**
-     * searches the hash map for a node by a given key.
-     *
-     * @param $key
-     * @return Node|null
-     * @throws InvalidKeyTypeException
-     * @throws UnsupportedKeyTypeException
-     */
-    public function getNodeByKey($key): ?Node {
-        $arrayIndex = $this->getBucketIndex($key);
-        /*
-         * the list is requested from the array based on
-         * the array index hash.
-         */
-        /** @var SinglyLinkedList $list */
-        if (!isset($this->bucket[$arrayIndex])) {
-            return null;
-        }
-        $list = $this->bucket[$arrayIndex];
-        if (!$list->containsKey($key)) {
-            return null;
-        }
-        $node = $list->getNodeByKey($key);
-        return $node;
-    }
-
     /**
      * returns the number of elements in the map
      *
@@ -239,10 +207,22 @@ public function size(): int {
         return $size;
     }
 
+    /**
+     * wrapper method for containsValue()
+     *
+     * @param $value
+     *
+     * @return bool
+     */
+    public function contains($value): bool {
+        return $this->containsValue($value);
+    }
+
     /**
      * determines whether the HashMap contains a value.
      *
      * @param $value
+     *
      * @return bool
      */
     public function containsValue($value): bool {
@@ -268,20 +248,11 @@ public function containsValue($value): bool {
         return false;
     }
 
-    /**
-     * wrapper method for containsValue()
-     *
-     * @param $value
-     * @return bool
-     */
-    public function contains($value):bool {
-        return $this->containsValue($value);
-    }
-
     /**
      * determines whether the HashMap contains a key.
      *
      * @param $key
+     *
      * @return bool
      */
     public function containsKey($key): bool {
@@ -315,6 +286,7 @@ public function containsKey($key): bool {
      *
      *
      * @param $value
+     *
      * @return Node|null
      */
     public function getNodeByValue($value): ?Node {
@@ -344,6 +316,7 @@ public function getNodeByValue($value): ?Node {
      * removes a node by a given key
      *
      * @param $key
+     *
      * @return bool
      * @throws InvalidKeyTypeException
      * @throws UnsupportedKeyTypeException
@@ -391,6 +364,32 @@ public function clear() {
         $this->initializeBucket();
     }
 
+    /**
+     * @return array
+     */
+    public function countPerBucket() {
+        $i     = 0;
+        $array = [];
+        /** @var SinglyLinkedList $list */
+        foreach ($this->bucket as $list) {
+            $array[$i] = $list->size();
+            $i++;
+        }
+        return $array;
+    }
+
+    /**
+     * returns the hash table as an array
+     * @return array
+     */
+    public function toArray(): array {
+        $array = [];
+        foreach ($this->keySet() as $key) {
+            $array[$key] = $this->get($key);
+        }
+        return $array;
+    }
+
     /**
      * basic implementation of Java-like keySet().
      * The method returns an array containing the node keys.
@@ -417,20 +416,45 @@ public function keySet(): array {
     }
 
     /**
-     * @return array
+     * @param $key
+     *
+     * @return mixed|null
+     * @throws InvalidKeyTypeException
+     * @throws UnsupportedKeyTypeException
      */
-    public function countPerBucket() {
-        $i     = 0;
-        $array = [];
+    public function get($key) {
+        $node = $this->getNodeByKey($key);
+        if (null === $node) return null;
+        return $node->getValue();
+    }
+
+    /**
+     * searches the hash map for a node by a given key.
+     *
+     * @param $key
+     *
+     * @return Node|null
+     * @throws InvalidKeyTypeException
+     * @throws UnsupportedKeyTypeException
+     */
+    public function getNodeByKey($key): ?Node {
+        $arrayIndex = $this->getBucketIndex($key);
+        /*
+         * the list is requested from the array based on
+         * the array index hash.
+         */
         /** @var SinglyLinkedList $list */
-        foreach ($this->bucket as $list) {
-            $array[$i] = $list->size();
-            $i++;
+        if (!isset($this->bucket[$arrayIndex])) {
+            return null;
         }
-        return $array;
+        $list = $this->bucket[$arrayIndex];
+        if (!$list->containsKey($key)) {
+            return null;
+        }
+        $node = $list->getNodeByKey($key);
+        return $node;
     }
 
-
     /**
      * Specify data which should be serialized to JSON
      *
@@ -446,4 +470,4 @@ public function jsonSerialize() {
         ];
     }
 
-}
+}