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
      */