Fix data types in binary tree

mgechev · mgechev · commit b52ecef4da87 · 2015-01-09T18:54:34.000+02:00
diff --git a/src/data-structures/binary-search-tree.js b/src/data-structures/binary-search-tree.js
@@ -8,9 +8,10 @@
   /**
    * A node of the tree
    *
+   * @class
    * @public
    * @constructor
-   * @param {number|string} Value of the node
+   * @param {Number|String} Value of the node
    * @param {Node} Left subling
    * @param {Node} Right sibling
    * @param {Node} Parent of the node
@@ -37,7 +38,7 @@
    * O(n) in the worst case.
    *
    * @public
-   * @param {number|string} Value
+   * @param {Number|String} Value
    * @param {[Node]} Current node
    */
   BinaryTree.prototype.insert = function (value, current) {
@@ -139,7 +140,7 @@
    * Finds a node by it's value. Average runtime complexity O(log n) 
    *
    * @public
-   * @param {number|string} Value of the node which should be found
+   * @param {Number|String} Value of the node which should be found
    */
   BinaryTree.prototype.find = function (value) {
     return this._find(value, this._root);
@@ -149,22 +150,22 @@
    * Finds a node by it's value in given sub-tree. Average runtime complexity: O(log n).
    *
    * @private
-   * @param {number|string} Value of the node which should be found
+   * @param {Number|String} Value of the node which should be found
    * @param {Node} Current node to be checked
    */
   BinaryTree.prototype._find = function (value, current) {
     if (!current)
       return null;
-   
+
     if (current.value === value)
       return current;
-   
+
     if (current.value > value)
       return this._find(value, current._left);
-   
+
     if (current.value < value)
       return this._find(value, current._right);
-    
+
   };
 
   /**
@@ -226,7 +227,7 @@
    *
    * @private
    * @param {Node} Root of the sub-tree
-   * @param {[number|string]} Current minimum value of the sub-tree
+   * @param {[Number|String]} Current minimum value of the sub-tree
    * @returns {Node} The node with minimum value in the sub-tree
    */
   BinaryTree.prototype._findMin = function (node, current) {
@@ -243,7 +244,7 @@
    *
    * @private
    * @param {Node} Root of the sub-tree
-   * @param {[number|string]} Current maximum value of the sub-tree
+   * @param {[Number|String]} Current maximum value of the sub-tree
    * @returns {Node} The node with maximum value in the sub-tree
    */
   BinaryTree.prototype._findMax = function (node, current) {
diff --git a/src/data-structures/heap.js b/src/data-structures/heap.js
@@ -25,7 +25,7 @@
    * Complexity O(log n)
    *
    * @private
-   * @param {number} index The parent
+   * @param {Number} index The parent
    */
   Heap.prototype._heapify = function (index) {
     var extr = index,
@@ -55,9 +55,9 @@
    * Changes the key for give index. Complexity O(log n).
    *
    * @public
-   * @param {number} index Index which key should be changed
-   * @param {number} value New value of the key
-   * @returns {number} parent The new position of the element
+   * @param {Number} index Index which key should be changed
+   * @param {Number} value New value of the key
+   * @returns {Number} parent The new position of the element
    */
   Heap.prototype.changeKey = function (index, value) {
     this._heap[index] = value;
@@ -92,8 +92,8 @@
    * Adds new element to the heap. Complexity O(log n).
    *
    * @public
-   * @param {number} value The new value which will be inserted
-   * @returns {number}  The index of the inserted value
+   * @param {Number} value The new value which will be inserted
+   * @returns {Number}  The index of the inserted value
    */
   Heap.prototype.add = function (value) {
     this._heap.push(value);
@@ -104,7 +104,7 @@
    * Gets the current value which is on the top of the heap. Complexity O(1).
    *
    * @public
-   * returns {numner} The current top value.
+   * returns {Number} The current top value.
    */
   Heap.prototype.top = function () {
     return this._heap[0];
@@ -116,7 +116,7 @@
    * Complexity O(log n).
    *
    * @public
-   * @returns {number} The extremum value
+   * @returns {Number} The extremum value
    */
   Heap.prototype.extract = function () {
     if (!this._heap.length) {
