Merge pull request mgechev#78 from Jakehp/master

JakeHP · JakeHP · commit 5a84957f26e2 · 2015-07-13T21:01:59.000-05:00
Added docs to Hash table.
diff --git a/src/data-structures/hash-table.js b/src/data-structures/hash-table.js
@@ -26,22 +26,42 @@
 (function (exports) {
   'use strict';
 
+  /**
+   * Constructs a Node to store data and next/prev nodes in Hash table.
+   *
+   * @public
+   * @constructor
+   * @param {Number|String} key Key of the node.
+   * @param {Number|String} data Data to be stored in hash table.
+   */
   exports.Node = function (key, data) {
     this.key = key;
     this.data = data;
     this.next = undefined;
     this.prev = undefined;
   };
 
+  /**
+   * Construct a Hash table..
+   *
+   * @public
+   * @constructor
+   */
   exports.Hashtable = function () {
     this.buckets = [];
     // The higher the bucket count; less likely for collisions.
     this.maxBucketCount = 100;
   };
 
-  /*
-    Using simple non-crypto x->integer based hash.
-  */
+  /**
+   * Simple non-crypto hash used to hash keys, which determines
+   * while bucket the value will be placed in.
+   * A javascript implementation of Java's 32bitint hash.
+   *
+   * @public
+   * @method
+   * @param {Number|String} val Key to be hashed.
+   */
   exports.Hashtable.prototype.hashCode = function (val) {
     var i;
     var hashCode = 0;
@@ -63,6 +83,14 @@
     return hashCode;
   };
 
+  /**
+   * Puts data into the table based on hashed key value.
+   *
+   * @public
+   * @method
+   * @param {Number|String} key Key for data.
+   * @param {Number|String} data Data to be stored in table.
+   */
   exports.Hashtable.prototype.put = function (key, data, hashCode) {
     /*
       Make collision testing easy with optional hashCode parameter.
@@ -104,6 +132,13 @@
     newNode.prev = first;
   };
 
+  /**
+   * Get's data from the table based on key.
+   *
+   * @public
+   * @method
+   * @param {Number|String} key Key for data to be retrieved.
+   */
   exports.Hashtable.prototype.get = function (key, hashCode) {
     /*
       Make collision testing easy with optional hashCode parameter.
@@ -143,6 +178,13 @@
     }
   };
 
+  /**
+   * Removes data from the table based on key.
+   *
+   * @public
+   * @method
+   * @param {Number|String} key Key of the data to be removed.
+   */
   exports.Hashtable.prototype.remove = function (key, hashCode) {
     /*
       Make collision testing easy with optional hashCode parameter.
