refactor(arrays): update arg order, fix shuffle()

thi-ng · Feb 14, 2019 · b01abaa · b01abaa
1 parent 0007152
commit b01abaa
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 5 deletions.
diff --git a/packages/arrays/src/binary-search.ts b/packages/arrays/src/binary-search.ts
@@ -12,14 +12,14 @@ import { compare } from "@thi.ng/compare";
  * to identify the index of `x`. The sort order of `buf` MUST be
  * compatible with that of `cmp`.
  *
- * @param x
  * @param buf
+ * @param x
  * @param key
  * @param cmp
  */
 export const binarySearch = <A, B>(
-    x: A,
     buf: ArrayLike<A>,
+    x: A,
     key: Fn<A, B> = (x) => <any>x,
     cmp: Comparator<B> = compare,
 ) => {

diff --git a/packages/arrays/src/fuzzy-match.ts b/packages/arrays/src/fuzzy-match.ts
@@ -13,13 +13,13 @@ import { equiv as _eq } from "@thi.ng/equiv";
  *
  * @see thi.ng/transducers/xform/filterFuzzy
  *
- * @param query
  * @param domain
+ * @param query
  * @param equiv
  */
 export const fuzzyMatch = <T>(
-    query: ArrayLike<T>,
     domain: ArrayLike<T>,
+    query: ArrayLike<T>,
     equiv: Predicate2<any> = _eq
 ) => {
     const nd = domain.length;

diff --git a/packages/arrays/src/shuffle.ts b/packages/arrays/src/shuffle.ts
@@ -1,8 +1,19 @@
 import { IRandom, SYSTEM } from "@thi.ng/random";
 
+/**
+ * Shuffles the first `n` items of given array, using Fisher-yates and
+ * optional `rnd` PRNG. If `n` is `undefined`, the entire array will be
+ * shuffled.
+ *
+ *
+ * @param buf
+ * @param n
+ * @param rnd
+ */
 export const shuffle =
     (buf: any[], n = buf.length, rnd: IRandom = SYSTEM) => {
-        const l = buf.length;
+        n = Math.min(n, buf.length);
+        const l = n;
         if (l > 1) {
             n = Math.min(n, l);
             while (--n >= 0) {