Completed
Push — master ( 303a8a...0de0f7 )
by Siro Díaz
01:34
created

AVLTree::updateHeight()   A

Complexity

Conditions 3
Paths 4

Size

Total Lines 4
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 3
eloc 3
nc 4
nop 1
1
<?php
2
/**
3
 * DataStructures for PHP
4
 *
5
 * @link      https://github.com/SiroDiaz/DataStructures
6
 * @copyright Copyright (c) 2017 Siro Díaz Palazón
7
 * @license   https://github.com/SiroDiaz/DataStructures/blob/master/README.md (MIT License)
8
 */
9
namespace DataStructures\Trees;
10
11
use DataStructures\Trees\BinaryTreeAbstract;
12
use DataStructures\Trees\Nodes\AVLNode;
13
14
/**
15
 * AVLTree
16
 *
17
 * This class is an implementation of a AVL tree. It has as main feature that access,
18
 * insertion and deletion is O(log n). This is like a BST but it has a slightly difference
19
 * in nodes: contains a height attribute, used to detect when is needed to rebalance the
20
 * tree to keep the O(log n).
21
 *
22
 * @author Siro Diaz Palazon <[email protected]>
23
 */
24
class AVLTree extends BinaryTreeAbstract {
25
    
26
    /**
27
     * Creates a AVLNode.
28
     *
29
     * @param int|string $key the key used to store.
30
     * @param mixed $data the data.
31
     * @param DataStructures\Trees\Nodes\AVLNode|null $parent the parent node.
32
     * @param DataStructures\Trees\Nodes\AVLNode|null $left the left child node.
33
     * @param DataStructures\Trees\Nodes\AVLNode|null $right the right child node.
34
     *
35
     * @return DataStructures\Trees\Nodes\AVLNode the new node created.
36
     */
37
    public function createNode($key, $data, $parent = null, $left = null, $right = null) {
38
        return new AVLNode($key, $data, $parent, $left, $right);
39
    }
40
41
    /**
42
     * Does a right rotation.
43
     * Example, rotate Y
44
     *    k2                   k1
45
     *   /  \                 /  \
46
     *  k1   Z     ==>       X   k2
47
     * / \                      /  \
48
     *X   Y                    Y    Z
49
     *
50
     */
51
    private function rightRotation(AVLNode $node) {
52
        $aux = $node->right;
53
        $node->right = &$aux->left;
54
        $aux->left = $node;
55
56
        $node->height = 1 + max($node->left->height, $node->right->height);
57
        $aux->height = 1 + max($aux->right->height, $node->height);
58
59
        $node = &$aux;
60
    }
61
62
    /*  Does a right rotation.
63
     *    k2                       k1
64
     *  /  \                     /  \
65
     * X    k1         ==>      k2   Z
66
     *     /  \                /  \
67
     *    Y    Z              X    Y
68
     */
69
    private function leftRotation(AVLNode $node) {
70
       $aux = $node->left;
71
       $node->left = &$aux->right;
72
       $aux->right = $node;
73
74
       $node->height = 1 + max($node->left->height, $node->right->height);
75
       $aux->height = 1 + max($node->height, $aux->left->height);
76
77
       $node = &$aux;
78
    }
79
80
    /**
81
     * Double right rotation does first a left rotation of right child node
82
     * that detects the imbalance and finally does a right rotation
83
     * in the subtree root that detects the imbalance.
84
     */
85
    private function doubleRightRotation(AVLNode $node) {
86
        $this->leftRotation($node->right);
87
        $this->rightRotation($node);
88
    }
89
90
    /**
91
     * Double left rotation does first a right rotation of left child node
92
     * that detects the imbalance and finally does a left rotation
93
     * in the subtree root that detects the imbalance.
94
     */
95
    private function doubleLeftRotation(AVLNode $node) {
96
        $this->rightRotation($node->left);
97
        $this->leftRotation($node);
98
    }
99
}