Added annotations for FibonacciHeap

Author: BasicPrimitives

src.primitives/algorithms/FibonacciHeap.js

@@ -1,8 +1,20 @@
-primitives.common.FibonacciHeap = function (isMaximum) {
+/**
+ * Creates Fibonacci Heap structure
+ * 
+ * @param {boolean} isMaximum Is maximum heap
+ * @returns {FibonacciHeap} Returns new FibonacciHeap object
+ */
+primitives.common.FibonacciHeap = function (isMaximum) {
 	var root = null,
 		count = 0,
 		nodes = {};
 
+   /**
+	* @typedef {Object} HeapResult
+	* @property {string} key Key
+	* @property {number} priority Priority
+	* @property {Object} item Context object
+	*/
 	function Result(node) {
 		this.key = node.key;
 		this.priority = node.priority;
@@ -22,6 +34,11 @@
 		this.right = null;
 	}
 
+	/**
+	 * Validates internal structure consistency.
+	 * 
+	 * @returns {boolean} Returns true if structure pass data consistency check.
+	 */
 	function validate() {
 		var totalNodes = 0;
 		for (var key in nodes) {
@@ -105,6 +122,12 @@
 		}
 	}
 
+	/**
+	 * Adds a new item into the heap
+	 * @param {string} key A key of the new element 
+	 * @param {number} priority A priority of the new element
+	 * @param {object} item A context object of the new element 
+	 */
 	function add(key, priority, item) {
 		if (nodes.hasOwnProperty(key)) {
 			throw "Duplicate keys are not supported!";
@@ -145,6 +168,11 @@
 		node.left = node.key;
 	}
 
+	/**
+	 * Gets priority of element by key
+	 * @param {string} key The element key
+	 * @returns {number} Returns priority of the element
+	 */
 	function getPriority(key) {
 		var result = null;
 		if (nodes.hasOwnProperty(key)) {
@@ -153,6 +181,11 @@
 		return result;
 	}
 
+	/**
+	 * Returns heap root element
+	 * 
+	 * @returns {HeapResult} Returns root element of the heap 
+	 */
 	function heapRoot() {
 		var result = null;
 		if (root != null) {
@@ -161,6 +194,11 @@
 		return result;
 	}
 
+	/**
+	 * Returns heap root element with removal
+	 * 
+	 * @returns {HeapResult} Returns root element of the heap 
+	 */
 	function extractRoot() {
 		var result = heapRoot();
 		if (result != null) {
@@ -240,6 +278,11 @@
 		node2.parent = node1.key;
 	}
 
+	/**
+	 * Sets priority of an element by key
+	 * @param {string} key The key of the element 
+	 * @param {number} priority Priority
+	 */
 	function setPriority(key, priority) {
 		var node = nodes[key];
 		if (isMaximum ? node.priority > priority : node.priority < priority) {
@@ -284,6 +327,10 @@
 		}
 	}
 
+	/**
+	 * Deletes heap element by key
+	 * @param {string} key The Key 
+	 */
 	function deleteKey(key) {
 		setPriority(key, isMaximum ? Infinity : -1);
 		extractRoot();