@thi.ng/arrays 2.6.4 → 2.7.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-10-23T07:37:37Z
+- **Last updated**: 2023-10-27T16:56:24Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [2.7.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/arrays@2.7.0) (2023-10-27)
+
+#### 🚀 Features
+
+- add rotate(), rotateTyped() ([c1d322e](https://github.com/thi-ng/umbrella/commit/c1d322e))
+
 ## [2.6.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/arrays@2.6.0) (2023-10-05)
 
 #### 🚀 Features

package/README.md

@@ -50,7 +50,7 @@ For Node.js REPL:
 const arrays = await import("@thi.ng/arrays");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 2.75 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 2.89 KB
 
 ## Dependencies
 
@@ -81,34 +81,35 @@ A selection:
 
 [Generated API docs](https://docs.thi.ng/umbrella/arrays/)
 
-- [arrayIterator()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/iterator.ts)
-- [argMin() / argMax()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/argmin.ts)
-- [argSort()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/arg-sort.ts)
-- [binarySearch()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/binary-search.ts)
-- [bisect()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/bisect.ts)
-- [blit1d() / blit2d()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/blit.ts)
-- [endsWith()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/ends-with.ts)
-- [ensureArray()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/ensure-array.ts)
-- [ensureIterable()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/ensure-iterable.ts)
-- [fillRange()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/fill-range.ts)
-- [find()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/find.ts)
-- [floydRivest()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/floyd-rivest.ts)
-- [fuzzyMatch()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/fuzzy-match.ts)
-- [insert()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/insert.ts)
-- [into()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/into.ts)
-- [isSorted()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/is-sorted.ts)
-- [levenshtein()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/levenshtein.ts)
-- [multiSwap()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/swap.ts)
-- [peek()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/peek.ts)
-- [quickSort()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/quicksort.ts)
-- [selectThresholdMin() / selectThresholdMax()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/threshold.ts)
-- [shuffle()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/shuffle.ts) (w/ custom PRNG support)
-- [shuffleRange()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/shuffle.ts) (w/ custom PRNG support)
-- [sortByCachedKey()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/sort-cached.ts)
-- [startsWith()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/starts-with.ts)
-- [swap()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/swap.ts)
-- [swizzle()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/swizzle.ts)
-- [topoSort()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/topo-sort.ts)
+- [`arrayIterator()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/iterator.ts)
+- [`argMin()` / argMax()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/argmin.ts)
+- [`argSort()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/arg-sort.ts)
+- [`binarySearch()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/binary-search.ts)
+- [`bisect()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/bisect.ts)
+- [`blit1d()` / blit2d()](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/blit.ts)
+- [`endsWith()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/ends-with.ts)
+- [`ensureArray()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/ensure-array.ts)
+- [`ensureIterable()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/ensure-iterable.ts)
+- [`fillRange()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/fill-range.ts)
+- [`find()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/find.ts)
+- [`floydRivest()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/floyd-rivest.ts)
+- [`fuzzyMatch()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/fuzzy-match.ts)
+- [`insert()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/insert.ts)
+- [`into()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/into.ts)
+- [`isSorted()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/is-sorted.ts)
+- [`levenshtein()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/levenshtein.ts)
+- [`multiSwap()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/swap.ts)
+- [`peek()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/peek.ts)
+- [`quickSort()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/quicksort.ts)
+- [`rotate()` / `rotateTyped()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/rotate.ts)
+- [`selectThresholdMin()` / `selectThresholdMax()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/threshold.ts)
+- [`shuffle()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/shuffle.ts) (w/ custom PRNG support)
+- [`shuffleRange()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/shuffle.ts) (w/ custom PRNG support)
+- [`sortByCachedKey()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/sort-cached.ts)
+- [`startsWith()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/starts-with.ts)
+- [`swap()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/swap.ts)
+- [`swizzle()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/swizzle.ts)
+- [`topoSort()`](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays/src/topo-sort.ts)
 
 ### Binary search result predicates
 

package/index.d.ts

@@ -18,6 +18,7 @@ export * from "./iterator.js";
 export * from "./levenshtein.js";
 export * from "./peek.js";
 export * from "./quicksort.js";
+export * from "./rotate.js";
 export * from "./shuffle.js";
 export * from "./sort-cached.js";
 export * from "./starts-with.js";

package/index.js

@@ -18,6 +18,7 @@ export * from "./iterator.js";
 export * from "./levenshtein.js";
 export * from "./peek.js";
 export * from "./quicksort.js";
+export * from "./rotate.js";
 export * from "./shuffle.js";
 export * from "./sort-cached.js";
 export * from "./starts-with.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/arrays",
-  "version": "2.6.4",
+  "version": "2.7.0",
   "description": "Array / Arraylike utilities",
   "type": "module",
   "module": "./index.js",
@@ -38,8 +38,8 @@
     "@thi.ng/checks": "^3.4.6",
     "@thi.ng/compare": "^2.2.1",
     "@thi.ng/equiv": "^2.1.31",
-    "@thi.ng/errors": "^2.3.6",
-    "@thi.ng/random": "^3.6.9"
+    "@thi.ng/errors": "^2.4.0",
+    "@thi.ng/random": "^3.6.10"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.38.0",
@@ -137,6 +137,9 @@
     "./quicksort": {
       "default": "./quicksort.js"
     },
+    "./rotate": {
+      "default": "./rotate.js"
+    },
     "./shuffle": {
       "default": "./shuffle.js"
     },
@@ -162,5 +165,5 @@
   "thi.ng": {
     "year": 2018
   },
-  "gitHead": "8d46d9326a9f9b81d65e7e274446f5964f9942ac\n"
+  "gitHead": "502e8fa937677ff7bc4fbd0906d8c8b4b0b471e5\n"
 }

package/rotate.d.ts

@@ -0,0 +1,22 @@
+import type { TypedArray } from "@thi.ng/api";
+/**
+ * Rotates array by `num` items. If `num < 0` items are rotated left (towards
+ * the beginning of the array), otherwise to the right (end). The rotation
+ * distance will be `num % buf.length`. The function is no-op if the resulting
+ * distance is zero or `buf` is empty.
+ *
+ * @remarks
+ * Not suitable for typed arrays. Use {@link rotateTyped} for those.
+ *
+ * @param buf
+ * @param num
+ */
+export declare const rotate: <T>(buf: T[], num: number) => T[];
+/**
+ * Same as {@link rotate}, but for optimized for typed arrays!
+ *
+ * @param buf
+ * @param num
+ */
+export declare const rotateTyped: (buf: TypedArray, num: number) => TypedArray;
+//# sourceMappingURL=rotate.d.ts.map

package/rotate.js

@@ -0,0 +1,45 @@
+/**
+ * Rotates array by `num` items. If `num < 0` items are rotated left (towards
+ * the beginning of the array), otherwise to the right (end). The rotation
+ * distance will be `num % buf.length`. The function is no-op if the resulting
+ * distance is zero or `buf` is empty.
+ *
+ * @remarks
+ * Not suitable for typed arrays. Use {@link rotateTyped} for those.
+ *
+ * @param buf
+ * @param num
+ */
+export const rotate = (buf, num) => {
+    if (!(num = __distance(buf, num)))
+        return buf;
+    if (num < 0) {
+        buf.push(...buf.splice(0, -num));
+    }
+    else {
+        buf.unshift(...buf.splice(-num));
+    }
+    return buf;
+};
+/**
+ * Same as {@link rotate}, but for optimized for typed arrays!
+ *
+ * @param buf
+ * @param num
+ */
+export const rotateTyped = (buf, num) => {
+    if (!(num = __distance(buf, num)))
+        return buf;
+    if (num < 0) {
+        const tmp = buf.slice(0, -num);
+        buf.copyWithin(0, -num);
+        buf.set(tmp, buf.length + num);
+    }
+    else if (num > 0) {
+        const tmp = buf.slice(buf.length - num);
+        buf.copyWithin(num, 0);
+        buf.set(tmp, 0);
+    }
+    return buf;
+};
+const __distance = (buf, num) => buf.length ? (num | 0) % buf.length : 0;