restructuring folders

Author: doganoo

src/Lists/RunnerTechnique.php renamed to src/algorithm/RunnerTechnique.php

@@ -0,0 +1,54 @@
+<?php
+/**
+ * MIT License
+ *
+ * Copyright (c) 2018 Dogan Ucar, <[email protected]>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+namespace doganoo\PHPAlgorithms\Common;
+
+
+use doganoo\PHPAlgorithms\Common\Util\MapUtil;
+
+class NodeKey {
+    /**
+     * @var int
+     */
+    private $key = 0;
+
+    /**
+     * NodeKey constructor.
+     *
+     * @param $value
+     * @throws Exception\InvalidKeyTypeException
+     * @throws Exception\UnsupportedKeyTypeException
+     */
+    public function __construct($value) {
+        $key = MapUtil::normalizeKey($value);
+        $this->key = $key;
+    }
+
+    public function __toString() {
+        $string = (string)$this->key;
+        return $string;
+    }
+
+}

src/Sort/BubbleSort.php renamed to src/algorithm/sorting/BubbleSort.php

@@ -0,0 +1,52 @@
+<?php
+/**
+ * MIT License
+ *
+ * Copyright (c) 2018 Dogan Ucar, <[email protected]>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+namespace doganoo\PHPAlgorithms\Common;
+
+
+use doganoo\PHPAlgorithms\Common\Util\MapUtil;
+
+class NodeValue {
+    private $value = null;
+
+    /**
+     * NodeValue constructor.
+     *
+     * @param $value
+     * @throws Exception\InvalidKeyTypeException
+     * @throws Exception\UnsupportedKeyTypeException
+     */
+    public function __construct($value) {
+        $this->value = MapUtil::normalizeValue($value);
+    }
+
+    public function equals(NodeValue $value): bool {
+        return $this->value === $value->get();
+    }
+
+    public function get(): string {
+        return $this->value;
+    }
+}

src/Sort/MergeSort.php renamed to src/algorithm/sorting/MergeSort.php

@@ -23,11 +23,11 @@
  * SOFTWARE.
  */
 
-namespace doganoo\PHPAlgorithms\Exception;
+namespace doganoo\PHPAlgorithms\Common\Exception;
 /**
  * Class IndexOutOfBoundsException
  *
- * @package doganoo\PHPAlgorithms\Exception
+ * @package doganoo\PHPAlgorithms\common\Exception
  */
 class IndexOutOfBoundsException extends \Exception {
 

src/Sort/QuickSort.php renamed to src/algorithm/sorting/QuickSort.php

@@ -23,12 +23,12 @@
  * SOFTWARE.
  */
 
-namespace doganoo\PHPAlgorithms\Exception;
+namespace doganoo\PHPAlgorithms\Common\Exception;
 
 /**
  * Class InvalidKeyTypeException
  *
- * @package doganoo\PHPAlgorithms\Exception
+ * @package doganoo\PHPAlgorithms\common\Exception
  */
 class InvalidKeyTypeException extends \Exception {
 

src/common/NodeKey.php

@@ -23,12 +23,12 @@
  * SOFTWARE.
  */
 
-namespace doganoo\PHPAlgorithms\Exception;
+namespace doganoo\PHPAlgorithms\common\Exception;
 
 /**
  * Class UnsupportedKeyTypeException
  *
- * @package doganoo\PHPAlgorithms\Exception
+ * @package doganoo\PHPAlgorithms\common\Exception
  */
 class UnsupportedKeyTypeException extends \Exception {
 

src/common/NodeValue.php

@@ -23,7 +23,7 @@
  * SOFTWARE.
  */
 
-namespace doganoo\PHPAlgorithms\Util;
+namespace doganoo\PHPAlgorithms\Common\Util;
 
 /**
  * Class Logger

src/Exception/IndexOutOfBoundsException.php renamed to src/common/exception/IndexOutOfBoundsException.php

@@ -23,10 +23,10 @@
  * SOFTWARE.
  */
 
-namespace doganoo\PHPAlgorithms\Util;
+namespace doganoo\PHPAlgorithms\Common\Util;
 
-use doganoo\PHPAlgorithms\Exception\InvalidKeyTypeException;
-use doganoo\PHPAlgorithms\Exception\UnsupportedKeyTypeException;
+use doganoo\PHPAlgorithms\Common\Exception\InvalidKeyTypeException;
+use doganoo\PHPAlgorithms\Common\Exception\UnsupportedKeyTypeException;
 
 /**
  * Class Util
@@ -148,4 +148,48 @@ public static function doubleToKey(double $double): int {
     public static function booleanToKey(bool $bool): int {
         return $bool ? 1 : 0;
     }
+
+    /**
+     * normalizes a given key to a int. This method converts currently the following
+     * types to a int:
+     *
+     * <ul>objects</ul>
+     * <ul>arrays</ul>
+     * <ul>doubles</ul>
+     * <ul>floats</ul>
+     * <ul>boolean</ul>
+     * <ul>resource|null</ul>
+     * <ul>int</ul>
+     *
+     * @param $value
+     * @return string
+     * @throws InvalidKeyTypeException
+     * @throws UnsupportedKeyTypeException
+     */
+    public static function normalizeValue($value): string {
+        /* ensuring that the key is an integer.
+         * Therefore, some helper methods convert the key if
+         * necessary.
+         */
+        if (\is_object($value)) {
+            $value = \serialize($value);
+        } else if (\is_array($value)) {
+            $value = \json_encode($value);
+        } else if (\is_double($value)) {
+            $value = (string)$value;
+        } else if (\is_float($value)) {
+            $value = (string)$value;
+        } else if (\is_bool($value)) {
+            $value = $value ? "true" : "false";
+        } else if (\is_resource($value) || $value === null) {
+            //TODO resource/null
+            $value = $value;
+        } else if (\is_int($value)) {
+            return (string)$value;
+        } else {
+            throw new UnsupportedKeyTypeException();
+        }
+        return $value;
+    }
+
 }

src/Exception/InvalidKeyTypeException.php renamed to src/common/exception/InvalidKeyTypeException.php

@@ -23,10 +23,11 @@
  * SOFTWARE.
  */
 
-namespace doganoo\PHPAlgorithms\Maps;
+namespace doganoo\PHPAlgorithms\Datastructure\Maps;
 
-use doganoo\PHPAlgorithms\Lists\LinkedLists\SinglyLinkedList;
-use doganoo\PHPAlgorithms\Util\MapUtil;
+use doganoo\PHPAlgorithms\Common\Util\MapUtil;
+use doganoo\PHPAlgorithms\Datastructure\Lists\LinkedLists\SinglyLinkedList;
+use doganoo\PHPAlgorithms\Datastructure\lists\Node;
 
 /**
  * HashMap class - implementation of a map using hashes in order to avoid collisions
@@ -73,8 +74,8 @@ private function initializeBucket() {
      *
      * @param Node $node
      * @return bool
-     * @throws \doganoo\PHPAlgorithms\Exception\InvalidKeyTypeException
-     * @throws \doganoo\PHPAlgorithms\Exception\UnsupportedKeyTypeException
+     * @throws \doganoo\PHPAlgorithms\common\Exception\InvalidKeyTypeException
+     * @throws \doganoo\PHPAlgorithms\common\Exception\UnsupportedKeyTypeException
      */
     public function addNode(Node $node): bool {
         $added = $this->add($node->getKey(), $node->getValue());
@@ -88,8 +89,8 @@ public function addNode(Node $node): bool {
      * @param $key
      * @param $value
      * @return bool
-     * @throws \doganoo\PHPAlgorithms\Exception\InvalidKeyTypeException
-     * @throws \doganoo\PHPAlgorithms\Exception\UnsupportedKeyTypeException
+     * @throws \doganoo\PHPAlgorithms\common\Exception\InvalidKeyTypeException
+     * @throws \doganoo\PHPAlgorithms\common\Exception\UnsupportedKeyTypeException
      */
     public function add($key, $value): bool {
         $arrayIndex = $this->getBucketIndex($key);
@@ -125,8 +126,8 @@ public function add($key, $value): bool {
      *
      * @param $key
      * @return int
-     * @throws \doganoo\PHPAlgorithms\Exception\InvalidKeyTypeException
-     * @throws \doganoo\PHPAlgorithms\Exception\UnsupportedKeyTypeException
+     * @throws \doganoo\PHPAlgorithms\common\Exception\InvalidKeyTypeException
+     * @throws \doganoo\PHPAlgorithms\common\Exception\UnsupportedKeyTypeException
      */
     private function getBucketIndex($key) {
         /*
@@ -232,8 +233,8 @@ public function getNodeByValue($value): ?Node {
      *
      * @param $key
      * @return Node|null
-     * @throws \doganoo\PHPAlgorithms\Exception\InvalidKeyTypeException
-     * @throws \doganoo\PHPAlgorithms\Exception\UnsupportedKeyTypeException
+     * @throws \doganoo\PHPAlgorithms\common\Exception\InvalidKeyTypeException
+     * @throws \doganoo\PHPAlgorithms\common\Exception\UnsupportedKeyTypeException
      */
     public function getNodeByKey($key): ?Node {
         $arrayIndex = $this->getBucketIndex($key);
@@ -260,8 +261,8 @@ public function getNodeByKey($key): ?Node {
      *
      * @param $key
      * @return bool
-     * @throws \doganoo\PHPAlgorithms\Exception\InvalidKeyTypeException
-     * @throws \doganoo\PHPAlgorithms\Exception\UnsupportedKeyTypeException
+     * @throws \doganoo\PHPAlgorithms\common\Exception\InvalidKeyTypeException
+     * @throws \doganoo\PHPAlgorithms\common\Exception\UnsupportedKeyTypeException
      */
     public function remove($key): bool {
         //get the corresponding index to key

src/Exception/UnsupportedKeyTypeException.php renamed to src/common/exception/UnsupportedKeyTypeException.php

@@ -23,7 +23,7 @@
  * SOFTWARE.
  */
 
-namespace doganoo\PHPAlgorithms\StackQueue;
+namespace doganoo\PHPAlgorithms\Datastructure\StackQueue;
 
 
 /**

src/Util/Logger.php renamed to src/common/util/Logger.php

@@ -23,7 +23,7 @@
  * SOFTWARE.
  */
 
-namespace doganoo\PHPAlgorithms\StackQueue;
+namespace doganoo\PHPAlgorithms\Datastructure\StackQueue;
 
 
 /**

src/Util/MapUtil.php renamed to src/common/util/MapUtil.php

@@ -23,11 +23,10 @@
  * SOFTWARE.
  */
 
-namespace doganoo\PHPAlgorithms\Lists\ArrayLists;
+namespace doganoo\PHPAlgorithms\Datastructure\Lists\ArrayLists;
 
 
-use doganoo\PHPAlgorithms\Exception\IndexOutOfBoundsException;
-use doganoo\PHPAlgorithms\Util\Logger;
+use doganoo\PHPAlgorithms\Common\Exception\IndexOutOfBoundsException;
 use Traversable;
 
 /**

src/Maps/HashMap.php renamed to src/datastructure/Maps/HashMap.php

@@ -23,7 +23,7 @@
  * SOFTWARE.
  */
 
-namespace doganoo\PHPAlgorithms\Lists\ArrayLists;
+namespace doganoo\PHPAlgorithms\Datastructure\Lists\ArrayLists;
 
 /**
  * Class StringBuilder
@@ -114,7 +114,7 @@ public function indexOf(string $value) {
      *
      * @param int    $index
      * @param string $string
-     * @throws \doganoo\PHPAlgorithms\Exception\IndexOutOfBoundsException
+     * @throws \doganoo\PHPAlgorithms\common\Exception\IndexOutOfBoundsException
      */
     public function insert(int $index, string $string) {
         if (\strlen($string) > 1) {

src/StackQueue/Queue.php renamed to src/datastructure/StackQueue/Queue.php

@@ -23,10 +23,10 @@
  * SOFTWARE.
  */
 
-namespace doganoo\PHPAlgorithms\Lists\LinkedLists;
+namespace doganoo\PHPAlgorithms\Datastructure\Lists\LinkedLists;
 
 
-use doganoo\PHPAlgorithms\Maps\Node;
+use doganoo\PHPAlgorithms\Datastructure\lists\Node;
 
 /**
  * Class DoublyLinkedList
@@ -69,7 +69,7 @@ public function append(?Node $node): bool {
     /**
      * prepends a node on top of the list
      *
-     * @param Node|null $node
+     * @param \doganoo\PHPAlgorithms\Datastructure\lists\Node|null $node
      * @return bool
      */
     public function prepend(?Node $node): bool {