@thi.ng/adjacency 2.5.56 → 3.0.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-07-19T14:56:20Z
+- **Last updated**: 2024-07-22T13:15:57Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,15 @@ 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.
 
+# [3.0.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/adjacency@3.0.0) (2024-07-22)
+
+#### 🛑 Breaking changes
+
+- migrate/remove DisjointSet ([#486](https://github.com/thi-ng/umbrella/issues/486)) ([c4a9798](https://github.com/thi-ng/umbrella/commit/c4a9798))
+- BREAKING CHANGE: migrate DisjointSet to [@thi.ng/disjoint-set](https://github.com/thi-ng/umbrella/tree/main/packages/disjoint-set) pkg
+  - remove obsolete files
+  - update pkg
+
 ### [2.5.48](https://github.com/thi-ng/umbrella/tree/@thi.ng/adjacency@2.5.48) (2024-04-20)
 
 #### ♻️ Refactoring

package/README.md

@@ -7,7 +7,7 @@
 [![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 > [!NOTE]
-> This is one of 189 standalone projects, maintained as part
+> This is one of 198 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >
@@ -31,6 +31,12 @@
 
 Sparse & bitwise adjacency matrices, lists and selected traversal algorithms for directed & undirected graphs.
 
+> [!IMPORTANT]
+> In July 2024 this package was restructured and split-up to extract some
+> features into smaller more focused packages:
+>
+> - [@thi.ng/disjoint-set](https://thi.ng/disjoint-set)
+
 ### Graph implementations
 
 The following types all implement the [`IGraph`
@@ -84,7 +90,7 @@ For Node.js REPL:
 const adj = await import("@thi.ng/adjacency");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 2.74 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 2.53 KB
 
 ## Dependencies
 
@@ -92,9 +98,12 @@ Package sizes (brotli'd, pre-treeshake): ESM: 2.74 KB
 - [@thi.ng/arrays](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays)
 - [@thi.ng/bitfield](https://github.com/thi-ng/umbrella/tree/develop/packages/bitfield)
 - [@thi.ng/dcons](https://github.com/thi-ng/umbrella/tree/develop/packages/dcons)
+- [@thi.ng/disjoint-set](https://github.com/thi-ng/umbrella/tree/develop/packages/disjoint-set)
 - [@thi.ng/errors](https://github.com/thi-ng/umbrella/tree/develop/packages/errors)
 - [@thi.ng/sparse](https://github.com/thi-ng/umbrella/tree/develop/packages/sparse)
 
+Note: @thi.ng/api is in _most_ cases a type-only import (not used at runtime)
+
 ## Usage examples
 
 One project in this repo's

package/index.d.ts

@@ -1,6 +1,5 @@
 export * from "./api.js";
 export * from "./binary.js";
-export * from "./disjoint-set.js";
 export * from "./floyd-warshall.js";
 export * from "./list.js";
 export * from "./sparse.js";

package/index.js

@@ -1,6 +1,5 @@
 export * from "./api.js";
 export * from "./binary.js";
-export * from "./disjoint-set.js";
 export * from "./floyd-warshall.js";
 export * from "./list.js";
 export * from "./sparse.js";

package/mst.js

@@ -1,5 +1,5 @@
 import { sortByCachedKey } from "@thi.ng/arrays/sort-cached";
-import { DisjointSet } from "./disjoint-set.js";
+import { DisjointSet } from "@thi.ng/disjoint-set";
 const mst = (edges, maxID, cost, verts) => {
   const graph = new DisjointSet(maxID + 1);
   const res = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/adjacency",
-  "version": "2.5.56",
+  "version": "3.0.0",
   "description": "Sparse & bitwise adjacency matrices, lists and selected traversal algorithms for directed & undirected graphs",
   "type": "module",
   "module": "./index.js",
@@ -39,16 +39,17 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.6",
-    "@thi.ng/arrays": "^2.9.11",
-    "@thi.ng/bitfield": "^2.3.46",
-    "@thi.ng/dcons": "^3.2.118",
-    "@thi.ng/errors": "^2.5.12",
-    "@thi.ng/sparse": "^0.3.123"
+    "@thi.ng/api": "^8.11.7",
+    "@thi.ng/arrays": "^2.9.12",
+    "@thi.ng/bitfield": "^2.3.47",
+    "@thi.ng/dcons": "^3.2.119",
+    "@thi.ng/disjoint-set": "^1.1.0",
+    "@thi.ng/errors": "^2.5.13",
+    "@thi.ng/sparse": "^0.3.124"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.47.0",
-    "@thi.ng/vectors": "^7.11.4",
+    "@thi.ng/vectors": "^7.11.5",
     "esbuild": "^0.23.0",
     "typedoc": "^0.26.3",
     "typescript": "^5.5.3"
@@ -103,9 +104,6 @@
     "./dfs": {
       "default": "./dfs.js"
     },
-    "./disjoint-set": {
-      "default": "./disjoint-set.js"
-    },
     "./floyd-warshall": {
       "default": "./floyd-warshall.js"
     },
@@ -125,5 +123,5 @@
     ],
     "year": 2018
   },
-  "gitHead": "c7aaa453b01a45e5235517db9d2a283b97abac96\n"
+  "gitHead": "324d6b7dbf31558329e9fb6452e29b2f7db9c61a\n"
 }

package/disjoint-set.d.ts

@@ -1,60 +0,0 @@
-/**
- * Typed array based Disjoint Set implementation with quick union and path
- * compression, after Sedgewick & Wayne.
- *
- * @remarks
- * - https://en.wikipedia.org/wiki/Disjoint-set_data_structure
- * - https://algs4.cs.princeton.edu/lectures/15UnionFind-2x2.pdf
- */
-export declare class DisjointSet {
-    roots: Uint32Array;
-    ranks: Uint8Array;
-    count: number;
-    /**
-     * Creates new instance with `n` initial singular subsets.
-     *
-     * @param n - initial capacity, ID range [0..n)
-     */
-    constructor(n: number);
-    /**
-     * Returns canonical ID (tree root) for given `id`. Unless `id`
-     * already is unified with some other ID, this will always return
-     * `id` itself (since each node is initially its own root).
-     *
-     * @param id - node ID
-     */
-    canonical(id: number): number;
-    /**
-     * Connects combines the trees of the given two node IDs and returns
-     * the new resulting canonical tree root ID.
-     *
-     * @param a - node ID
-     * @param b - node ID
-     */
-    union(a: number, b: number): number;
-    /**
-     * Returns true, if the given two nodes belong to the same tree /
-     * subset.
-     *
-     * @param a - node ID
-     * @param b - node ID
-     */
-    unified(a: number, b: number): boolean;
-    /**
-     * Returns a `Map` of all subsets (connected components) with their
-     * canonical tree root IDs as keys and arrays of node IDs as values.
-     *
-     * @remarks
-     * If only the number of subsets is required, use the `count`
-     * property of this class instance instead (O(1), updated with each
-     * call to {@link DisjointSet.union}).
-     */
-    subsets(): Map<number, number[]>;
-}
-/**
- * Creates a new {@link DisjointSet} with capacity `n`.
- *
- * @param n -
- */
-export declare const defDisjointSet: (n: number) => DisjointSet;
-//# sourceMappingURL=disjoint-set.d.ts.map

package/disjoint-set.js

@@ -1,91 +0,0 @@
-import { fillRange } from "@thi.ng/arrays/fill-range";
-class DisjointSet {
-  roots;
-  ranks;
-  count;
-  /**
-   * Creates new instance with `n` initial singular subsets.
-   *
-   * @param n - initial capacity, ID range [0..n)
-   */
-  constructor(n) {
-    this.roots = fillRange(new Uint32Array(n));
-    this.ranks = new Uint8Array(n);
-    this.count = n;
-  }
-  /**
-   * Returns canonical ID (tree root) for given `id`. Unless `id`
-   * already is unified with some other ID, this will always return
-   * `id` itself (since each node is initially its own root).
-   *
-   * @param id - node ID
-   */
-  canonical(id) {
-    const roots = this.roots;
-    while (id !== roots[id]) {
-      id = roots[id] = roots[roots[id]];
-    }
-    return id;
-  }
-  /**
-   * Connects combines the trees of the given two node IDs and returns
-   * the new resulting canonical tree root ID.
-   *
-   * @param a - node ID
-   * @param b - node ID
-   */
-  union(a, b) {
-    const rootA = this.canonical(a);
-    const rootB = this.canonical(b);
-    if (rootA === rootB) {
-      return rootA;
-    }
-    this.count--;
-    const ranks = this.ranks;
-    const ra = ranks[rootA];
-    const rb = ranks[rootB];
-    if (ra < rb) {
-      return this.roots[rootA] = rootB;
-    }
-    ra === rb && ranks[rootA]++;
-    return this.roots[rootB] = rootA;
-  }
-  /**
-   * Returns true, if the given two nodes belong to the same tree /
-   * subset.
-   *
-   * @param a - node ID
-   * @param b - node ID
-   */
-  unified(a, b) {
-    return this.canonical(a) === this.canonical(b);
-  }
-  /**
-   * Returns a `Map` of all subsets (connected components) with their
-   * canonical tree root IDs as keys and arrays of node IDs as values.
-   *
-   * @remarks
-   * If only the number of subsets is required, use the `count`
-   * property of this class instance instead (O(1), updated with each
-   * call to {@link DisjointSet.union}).
-   */
-  subsets() {
-    const sets = /* @__PURE__ */ new Map();
-    const roots = this.roots;
-    for (let i = roots.length; i-- > 0; ) {
-      const id = this.canonical(i);
-      const s = sets.get(id);
-      if (s) {
-        s.push(i);
-      } else {
-        sets.set(id, [i]);
-      }
-    }
-    return sets;
-  }
-}
-const defDisjointSet = (n) => new DisjointSet(n);
-export {
-  DisjointSet,
-  defDisjointSet
-};