SiroDiaz / DataStructures

DataStructures/Trees/BinaryTreeAbstract.php

Doc Comments +11 added lines, -8 removed lines

@@ -234,7 +234,7 @@ 
     /**
      * Returns the minimum node from a given node in position X.
      *
-     * @param DataStructures\Trees\Nodes\BSTNode $node the start point.
+     * @param BinaryNodeInterface $node the start point.
      * @return DataStructures\Trees\Nodes\BSTNode|null the minimum node.
      */
     private function getMinNode(BinaryNodeInterface $node = null) {
@@ -252,7 +252,7 @@ 
     /**
      * Returns the maximum node from a given node in position X.
      *
-     * @param DataStructures\Trees\Nodes\BSTNode $node the start point.
+     * @param BinaryNodeInterface $node the start point.
      * @return DataStructures\Trees\Nodes\BSTNode|null the maximum node.
      */
     private function getMaxNode(BinaryNodeInterface $node = null) {
@@ -271,7 +271,7 @@ 
      * Deletes the node with the minimum key and returns it. The most left and more bottom.
      * 
      * @param DataStructures\Trees\Nodes\BSTNode|null if null takes the root.
-     * @return DataStructures\Trees\Nodes\BSTNode|null the minimum node or
+     * @return BinaryNodeInterface|null the minimum node or
      *  null if the tree is empty.
      */
     public function deleteMin(BinaryNodeInterface $node = null) {
@@ -287,7 +287,7 @@ 
      * Deletes the node with the maximum key and returns it. The most right and more bottom.
      * 
      * @param DataStructures\Trees\Nodes\BSTNode|null if null takes the root.
-     * @return DataStructures\Trees\Nodes\BSTNode|null the maximum node or
+     * @return BinaryNodeInterface|null the maximum node or
      *  null if the tree is empty.
      */
     public function deleteMax(BinaryNodeInterface $node = null) {
@@ -303,7 +303,7 @@ 
      * Deletes the node with the maximum key and returns it. The most right and more bottom.
      * 
      * @param DataStructures\Trees\Nodes\BSTNode|null if null takes the root.
-     * @return DataStructures\Trees\Nodes\BSTNode|null the maximum node or
+     * @return BinaryNodeInterface|null the maximum node or
      *  null if the tree is empty.
      */
     public function delete($key) {
@@ -321,7 +321,7 @@ 
      * that replaces the deleted node. Also decrease the size of tree.
      *
      * @param DataStructures\Trees\Nodes\BSTNode|null The node to be deleted.
-     * @return the node that replaces the deleted.
+     * @return DataStructures\Trees\Nodes\BSTNode|null node that replaces the deleted.
      */
     protected function _delete(BinaryNodeInterface &$node) {
         if($node !== null) {
@@ -409,7 +409,7 @@ 
      * Returns true if is leaf the node.
      *
      * @param DataStructures\Trees\Nodes\BSTNode|null $node default to null.
-     * @return true if is leaf the node, is not null and their subtrees has no
+     * @return boolean if is leaf the node, is not null and their subtrees has no
      *  pointers to successors.
      */
     public function isLeaf($node) : bool { // BinaryTreeNode
@@ -421,7 +421,7 @@ 
      * also are called a root node.
      *
      * @param DataStructures\Trees\Nodes\BSTNode|null $node default to null.
-     * @return true if is root the node, is not null and their subtrees has no
+     * @return boolean if is root the node, is not null and their subtrees has no
      *  pointers to successors.
      */
     public function isRoot($node) : bool {
@@ -446,6 +446,7 @@ 
      * @param DataStructures\Trees\Nodes\BSTNode|null $node.
      * @param Callable|null $callback the callback function to apply to each
      *  node.
+     * @param null|DataStructures\Trees\Nodes\BSTNode $node
      */
     private function _preorder($node, Callable $callback = null) {
         if($node === null) {
@@ -476,6 +477,7 @@ 
      * @param DataStructures\Trees\Nodes\BSTNode|null $node.
      * @param Callable|null $callback the callback function to apply to each
      *  node.
+     * @param null|DataStructures\Trees\Nodes\BSTNode $node
      */
     private function _inorder($node, Callable $callback = null) {
         if($node === null) {
@@ -507,6 +509,7 @@ 
      * @param DataStructures\Trees\Nodes\BSTNode|null $node.
      * @param Callable|null $callback the callback function to apply to each
      *  node.
+     * @param null|DataStructures\Trees\Nodes\BSTNode $node
      */
     private function _postorder($node, Callable $callback = null) {
         if($node === null) {

DataStructures/Lists/DoublyLinkedList.php

Doc Comments +2 added lines, -2 removed lines

@@ -137,7 +137,7 @@ 
     /**
      * Returns the last node with O(1).
      *
-     * @return DataStructures\Lists\Nodes\DoublyLinkedListNode|null if the list is empty.
+     * @return null|Node if the list is empty.
      */
     public function searchLast() {
         if($this->head === null) {
@@ -149,7 +149,7 @@ 
     /**
      * Generator for retrieve all nodes stored.
      * 
-     * @return null if the head is null (or list is empty)
+     * @return \Generator if the head is null (or list is empty)
      */
     public function getAll() {
         if($this->head === null) {

DataStructures/Lists/CircularLinkedList.php

Doc Comments +2 added lines, -3 removed lines

@@ -80,7 +80,6 @@ 
     /**
      * Add a new node in the specified index.
      *
-     * @param integer $index the position.
      * @param mixed $data the data to be stored.
      */
     private function insertEnd($data) {
@@ -145,7 +144,7 @@ 
     /**
      * Returns the last node with O(1).
      *
-     * @return mixed null if the list is empty.
+     * @return null|SimpleLinkedListNode null if the list is empty.
      */
     protected function searchLast() {
         if($this->head === null) {
@@ -206,7 +205,7 @@ 
     /**
      * Generator for retrieve all nodes stored.
      * 
-     * @return null if the head is null (or list is empty)
+     * @return \Generator if the head is null (or list is empty)
      */
     public function getAll() {
         if($this->head === null) {

DataStructures/Trees/AVLTree.php

Doc Comments +5 added lines, -5 removed lines

@@ -32,7 +32,7 @@ 
      * @param DataStructures\Trees\Nodes\AVLNode|null $left the left child node.
      * @param DataStructures\Trees\Nodes\AVLNode|null $right the right child node.
      *
-     * @return DataStructures\Trees\Nodes\AVLNode the new node created.
+     * @return AVLNode the new node created.
      */
     public function createNode($key, $data, $parent = null, $left = null, $right = null) {
         return new AVLNode($key, $data, $parent, $left, $right);
@@ -41,7 +41,7 @@ 
     /**
      * Does a right rotation.
      * 
-     * @param DataStructures\Trees\Nodes\AVLNode $node The node to be
+     * @param AVLNode $node The node to be
      * rotated.
      * @return DataStructures\Trees\Nodes\AVLNode
      */
@@ -74,7 +74,7 @@ 
     /**
      * Does a right rotation.
      *
-     * @param DataStructures\Trees\Nodes\AVLNode $node The node to be
+     * @param AVLNode $node The node to be
      * rotated.
      * @return DataStructures\Trees\Nodes\AVLNode
      */
@@ -112,7 +112,7 @@ 
      * in the subtree root that detects the imbalance.
      * Case Right-Left.
      *
-     * @param DataStructures\Trees\Nodes\AVLNode $node The node to be
+     * @param AVLNode $node The node to be
      * rotated.
      * @return DataStructures\Trees\Nodes\AVLNode
      */
@@ -127,7 +127,7 @@ 
      * in the subtree root that detects the imbalance.
      * Case Left-Right.
      *
-     * @param DataStructures\Trees\Nodes\AVLNode $node The node to be
+     * @param AVLNode $node The node to be
      * rotated.
      * @return DataStructures\Trees\Nodes\AVLNode
      */