- update js docs

Author: Isaac Ramirez

src/libs/std-random/std-random.js

@@ -28,6 +28,9 @@ class StdRandom {
   /**
    * Uniform
    *
+   * @todo Somehow I need to make this function to return
+   * real number values when [0.0, 1.0] are provided.
+   *
    * @constructor
    * @desc Returns a random real number uniformly in [0, 1).
    * @returns {number} A random real number uniformly in [0, 1).
@@ -66,6 +69,13 @@ class StdRandom {
       return getRandomInt(0, lo)
     }
 
+    /* NOTE: the book uses a signature like `uniform(0.0, 1.0)`
+     * to generate real or double numbers from [0, 1),
+     * in case you want create the same behaviour, then do
+     * `uniform()` and this will make the function to get to this
+     * returning value. In case you want to generate values from [0.0, 5.0)
+     * then I would recommend to do `uniform(0, 4.999)`.
+     */
     return Math.random()
   }
 

src/utils/array.utils.js

@@ -16,6 +16,27 @@ function isVector (v) {
   return false
 }
 
+/**
+ * Returns an array of length `n` filled with the values
+ * provided as `data` or computed if `data` is a function.
+ * @param {number} n
+ * @param {*|function} data `data` can be any literal value,
+ * _all the array will be filled with the same value_,
+ * or a function with signature `(number i)` that will compute
+ * a value based on the index `i` which is `i >= 0 && i < n`.
+ * @example <caption>Array of length 10 initialized to 0</caption>
+ * newArrayOf(10, 0) // [0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
+ * @example <caption>Array of length `n` with random values from 0 to `n`</caption>
+ * const n = 10
+ * newArrayOf(n, () => StdRandom.uniform(n)) // [0, 3, 9, 2, 2, 8, 4, 2, 4, 7]
+ * @example <caption>Array of random doubles from [0, 1)</caption>
+ * newArrayOf(3, () => StdRandom.uniform(0, 0.999)) // [0.712488850522207, 0.9280585621957204, 0.8184198432124032]
+ * newArrayOf(3, () => StdRandom.uniform()) // this is equivalent
+ * @example <caption>Array with numbers from 0 to 9</caption>
+ * newArrayOf(10, i => i) // [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
+ * @example <caption>Array of even numbers</caption>
+ * newArrayOf(5, i => (i + 1) * 2) // [2, 4, 6, 8, 10]
+ */
 function newArrayOf (n, data) {
   const a = []