SiroDiaz / DataStructures

DataStructures/Trees/BinaryTreeAbstract.php

Doc Comments +11 added lines, -8 removed lines

@@ -238,7 +238,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.
      */
     protected function getMinNode(BinaryNodeInterface $node = null) {
@@ -256,7 +256,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) {
@@ -275,7 +275,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) {
@@ -291,7 +291,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) {
@@ -307,7 +307,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) {
@@ -325,7 +325,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) {
@@ -413,7 +413,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
@@ -425,7 +425,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 {
@@ -450,6 +450,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) {
@@ -480,6 +481,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) {
@@ -511,6 +513,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) {