Comments added to the run-length encoding

mgechev · mgechev · commit fb48c18fb387 · 2013-05-14T10:25:23.000+03:00
diff --git a/src/compression/runlength/runlength.js b/src/compression/runlength/runlength.js
@@ -10,6 +10,10 @@ var runLengthEncoding = (function () {
 
     'use strict';
 
+    /**
+     * Convers a given string to sequence of numbers
+     * This takes O(n).
+     */
     function convertToAscii(str) {
         var result = '',
             currentChar = '',
@@ -25,7 +29,11 @@ var runLengthEncoding = (function () {
         }
         return result;
     }
-     
+    
+    /**
+     * Encodes the binary string to run-length encoding.
+     * Takes O(n^2).
+     */ 
     function runLength(vector) {
         var result = '',
             zeros = 0,
@@ -48,7 +56,11 @@ var runLengthEncoding = (function () {
         }
         return result;
     }
-     
+
+    /**
+     * Accepts a string and returns it's run-length encoded binary representation.
+     * Takes O(n^2).
+     */     
     return function (str) {
         var asciiString = convertToAscii(str);
         return runLength(asciiString);
