refactoring

Author: doganoo

composer.json

@@ -18,6 +18,7 @@
     "phpunit/phpunit": "6.5"
   },
   "require": {
-    "doganoo/php-util": "0.0.*"
+    "doganoo/php-util": "0.0.*",
+    "zumba/json-serializer": "*"
   }
 }

src/Algorithm/Search/BidirectionalSearch.php

@@ -38,7 +38,12 @@
  */
 class BidirectionalSearch {
 
-    public function hasPath(Node $start, Node $end) {
+    /**
+     * @param Node $start
+     * @param Node $end
+     * @return bool
+     */
+    public function hasPath(Node $start, Node $end): bool {
         $startList = $this->performSearch($start);
         $endList = $this->performSearch($end);
 
@@ -49,7 +54,7 @@ public function hasPath(Node $start, Node $end) {
             $startList->retainAll($endList);
             return $startList->length() > 0;
         }
-
+        return false;
     }
 
     /**

src/Algorithm/Search/DepthFirstSearch.php

@@ -53,9 +53,9 @@ public function search(AbstractGraph $graph) {
 
     /**
      * @param Node|null $node
-     * @return mixed
+     * @return void
      */
-    public function searchByNode(?Node $node) {
+    public function searchByNode(?Node $node): void {
         if (null === $node) {
             return;
         }

src/Algorithm/Sorting/QuickSort.php

@@ -23,7 +23,7 @@
  * SOFTWARE.
  */
 
-namespace doganoo\PHPAlgorithms\Sort;
+namespace doganoo\PHPAlgorithms\Algorithm\Sorting;
 
 
 use doganoo\PHPAlgorithms\Common\Interfaces\ISortable;
@@ -32,7 +32,7 @@
 /**
  * Class QuickSort
  *
- * @package doganoo\PHPAlgorithms\Sort
+ * @package doganoo\PHPAlgorithms\Sorting
  */
 class QuickSort implements ISortable {
     /**

src/Algorithm/Traversal/InOrder.php

@@ -27,24 +27,24 @@
 
 
 use doganoo\PHPAlgorithms\Common\Abstracts\AbstractTraverse;
+use doganoo\PHPAlgorithms\Common\Abstracts\AbstractTree;
 use doganoo\PHPAlgorithms\Common\Interfaces\IBinaryNode;
-use doganoo\PHPAlgorithms\Common\Interfaces\IBinaryTree;
 
 /**
  * Class InOrder
  *
  * @package doganoo\PHPAlgorithms\Algorithm\Traversal
  */
 class InOrder extends AbstractTraverse {
-    /** @var IBinaryTree|null */
+    /** @var AbstractTree|null */
     private $binarySearchTree = null;
 
     /**
      * InOrder constructor.
      *
-     * @param IBinaryTree $tree
+     * @param AbstractTree $tree
      */
-    public function __construct(IBinaryTree $tree) {
+    public function __construct(AbstractTree $tree) {
         $this->binarySearchTree = $tree;
     }
 

src/Algorithm/Traversal/PostOrder.php

@@ -26,24 +26,24 @@
 namespace doganoo\PHPAlgorithms\Algorithm\Traversal;
 
 use doganoo\PHPAlgorithms\Common\Abstracts\AbstractTraverse;
+use doganoo\PHPAlgorithms\Common\Abstracts\AbstractTree;
 use doganoo\PHPAlgorithms\Common\Interfaces\IBinaryNode;
-use doganoo\PHPAlgorithms\Common\Interfaces\IBinaryTree;
 
 /**
  * Class PostOrder
  *
  * @package doganoo\PHPAlgorithms\Algorithm\Traversal
  */
 class PostOrder extends AbstractTraverse {
-    /** @var IBinaryTree|null */
+    /** @var AbstractTree|null */
     private $tree = null;
 
     /**
      * PostOrder constructor.
      *
-     * @param IBinaryTree $tree
+     * @param AbstractTree $tree
      */
-    public function __construct(IBinaryTree $tree) {
+    public function __construct(AbstractTree $tree) {
         $this->tree = $tree;
     }
 

src/Algorithm/Traversal/PreOrder.php

@@ -26,24 +26,24 @@
 namespace doganoo\PHPAlgorithms\Algorithm\Traversal;
 
 use doganoo\PHPAlgorithms\Common\Abstracts\AbstractTraverse;
+use doganoo\PHPAlgorithms\Common\Abstracts\AbstractTree;
 use doganoo\PHPAlgorithms\Common\Interfaces\IBinaryNode;
-use doganoo\PHPAlgorithms\Common\Interfaces\IBinaryTree;
 
 /**
  * Class PreOrder
  *
  * @package doganoo\PHPAlgorithms\Algorithm\Traversal
  */
 class PreOrder extends AbstractTraverse {
-    /** @var IBinaryTree|null */
+    /** @var AbstractTree|null */
     private $tree = null;
 
     /**
      * PreOrder constructor.
      *
-     * @param IBinaryTree $tree
+     * @param AbstractTree $tree
      */
-    public function __construct(IBinaryTree $tree) {
+    public function __construct(AbstractTree $tree) {
         $this->tree = $tree;
     }
 

src/Common/Abstracts/AbstractLinkedList.php

@@ -310,7 +310,6 @@ public function isEmpty() {
      * TODO decide whether using add or append/prepend
      *
      * @param \doganoo\PHPAlgorithms\Datastructure\Lists\Node $node
-     * @throws \ReflectionException
      */
     public function addNode(Node $node) {
         $this->add($node->getKey(), $node->getValue());
@@ -479,21 +478,6 @@ public function replaceValue($key, $value): bool {
         return $replaced;
     }
 
-    /**
-     * string representation of a LinkedList instance
-     *
-     * @return string
-     */
-    public function __toString() {
-        $head = $this->getHead();
-        $string = "";
-        while ($head !== null) {
-            $string .= $head . "\n";
-            $head = $head->getNext();
-        }
-        return $string;
-    }
-
     //protected function removeDuplicates() {
     //    $node = $this->head;
     //    $previous = $this->head;

src/Common/Interfaces/Comparable.php

@@ -29,6 +29,7 @@
  * Interface Comparable
  *
  * @package doganoo\PHPAlgorithms\common\Interfaces
+ * @deprecated use IComparable instead (due to name conventions)
  */
 interface Comparable {
     /**

src/Common/Interfaces/IBinaryNode.php

@@ -30,7 +30,7 @@
  *
  * @package doganoo\PHPAlgorithms\Common\Interfaces
  */
-interface IBinaryNode extends INode, Comparable {
+interface IBinaryNode extends INode {
     /**
      * @return mixed
      */

src/Common/Interfaces/IBinaryTree.php

@@ -31,7 +31,7 @@
  * @package doganoo\PHPAlgorithms\Common\Interfaces
  * @deprecated
  */
-interface IBinaryTree {
+interface IBinaryTree extends IComparable {
     /**
      * @return IBinaryNode|null
      */

src/Common/Interfaces/ICache.php

@@ -30,7 +30,7 @@
  *
  * @package doganoo\PHPAlgorithms\common\Interfaces
  */
-interface ICache {
+interface ICache extends IComparable {
     /**
      * adds a new key value pair
      *

src/Common/Interfaces/IComparable.php

@@ -0,0 +1,35 @@
+<?php
+/**
+ * MIT License
+ *
+ * Copyright (c) 2018 Dogan Ucar, <dogan@dogan-ucar.de>
+ *
+ * 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\Interfaces;
+
+/**
+ * Interface IComparable
+ *
+ * @package doganoo\PHPAlgorithms\Common\Interfaces
+ */
+interface IComparable extends Comparable {
+
+}

src/Common/Interfaces/INode.php

@@ -30,7 +30,7 @@
  *
  * @package doganoo\PHPAlgorithms\common\Interfaces
  */
-interface INode {
+interface INode extends IComparable {
     /**
      * @return mixed
      */

src/Common/Interfaces/ISet.php

@@ -30,7 +30,7 @@
  *
  * @package doganoo\PHPAlgorithms\common\Interfaces
  */
-interface ISet {
+interface ISet extends IComparable {
     /**
      * Adds the specified element to this set if it is not already present (optional operation).
      *

src/Common/Interfaces/IUnaryNode.php

@@ -30,7 +30,7 @@
  *
  * @package doganoo\PHPAlgorithms\common\Interfaces
  */
-interface IUnaryNode extends Comparable {
+interface IUnaryNode extends IComparable {
     /**
      * @return mixed
      */

src/Common/Interfaces/IVector.php

@@ -30,7 +30,7 @@
  *
  * @package doganoo\PHPAlgorithms\Common\Interfaces
  */
-interface IVector {
+interface IVector extends IComparable {
     /**
      * sets a value in the vector
      *

src/Common/Util/Comparator.php

@@ -26,7 +26,7 @@
 namespace doganoo\PHPAlgorithms\Common\Util;
 
 
-use doganoo\PHPAlgorithms\Common\Interfaces\Comparable;
+use doganoo\PHPAlgorithms\Common\Interfaces\IComparable;
 
 /**
  * Class Comparator
@@ -47,7 +47,7 @@ private function __construct() {
      * @return bool
      */
     public static function equals($that, $other): bool {
-        if ($that instanceof Comparable) {
+        if ($that instanceof IComparable) {
             return $that->compareTo($other) == 0;
         }
         if (\is_object($that)) {
@@ -71,7 +71,7 @@ public static function equals($that, $other): bool {
      * @return bool
      */
     public static function lessThan($that, $other): bool {
-        if ($that instanceof Comparable) {
+        if ($that instanceof IComparable) {
             return $that->compareTo($other) == -1;
         }
         if (\is_object($that)) {
@@ -95,7 +95,7 @@ public static function lessThan($that, $other): bool {
      * @return bool
      */
     public static function lessThanEqual($that, $other): bool {
-        if ($that instanceof Comparable) {
+        if ($that instanceof IComparable) {
             return $that->compareTo($other) == -1;
         }
         if (\is_object($that)) {
@@ -119,7 +119,7 @@ public static function lessThanEqual($that, $other): bool {
      * @return bool
      */
     public static function greaterThan($that, $other): bool {
-        if ($that instanceof Comparable) {
+        if ($that instanceof IComparable) {
             return $that->compareTo($other) == 1;
         }
         if (\is_object($that)) {
@@ -143,7 +143,7 @@ public static function greaterThan($that, $other): bool {
      * @return bool
      */
     public static function greaterThanEqual($that, $other): bool {
-        if ($that instanceof Comparable) {
+        if ($that instanceof IComparable) {
             return $that->compareTo($other) == 1;
         }
         if (\is_object($that)) {

src/Common/Util/MapUtil.php

@@ -184,7 +184,6 @@ public static function normalizeValue($value): string {
             $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 {

src/Datastructure/Cache/LRUCache.php

@@ -59,7 +59,6 @@ public function __construct($capacity = 128) {
      * @param $key
      * @param $value
      * @return bool
-     * @throws \ReflectionException
      * @throws \doganoo\PHPAlgorithms\common\Exception\InvalidKeyTypeException
      * @throws \doganoo\PHPAlgorithms\common\Exception\UnsupportedKeyTypeException
      */
@@ -194,4 +193,17 @@ public function delete($key): bool {
         }
         return false;
     }
+
+    /**
+     * @param $object
+     * @return int
+     */
+    public function compareTo($object): int {
+        if ($object instanceof LRUCache) {
+            if (Comparator::equals($this->hashMap, $object->hashMap)) return 0;
+            if (Comparator::lessThan($this->hashMap, $object->hashMap)) return 1;
+            if (Comparator::greaterThan($this->hashMap, $object->hashMap)) return -1;
+        }
+        return -1;
+    }
 }

src/Datastructure/Cache/Node.php

@@ -25,15 +25,14 @@
 
 namespace doganoo\PHPAlgorithms\Datastructure\Cache;
 
-use doganoo\PHPAlgorithms\Common\Interfaces\Comparable;
 use doganoo\PHPAlgorithms\Common\Interfaces\INode;
 
 /**
  * Class Node
  *
  * @package doganoo\PHPAlgorithms\Datastructure\Cache
  */
-class Node implements INode, Comparable {
+class Node implements INode {
     private $key;
     private $value;
     private $previous;