From ebcef755c34c47c1cc6fd8f5f7a151828491f6e5 Mon Sep 17 00:00:00 2001 From: Karsten Schmidt Date: Sat, 20 Jul 2024 14:35:42 +0200 Subject: [PATCH] feat(sparse-set): import as new pkg (#486) - extract `DisjointSet` from thi.ng/adjacency --- packages/disjoint-set/LICENSE | 201 +++++++++++++++++++++++ packages/disjoint-set/README.md | 95 +++++++++++ packages/disjoint-set/api-extractor.json | 3 + packages/disjoint-set/package.json | 79 +++++++++ packages/disjoint-set/src/index.ts | 106 ++++++++++++ packages/disjoint-set/test/main.test.ts | 4 + packages/disjoint-set/test/tsconfig.json | 8 + packages/disjoint-set/tpl.readme.md | 35 ++++ packages/disjoint-set/tsconfig.json | 9 + 9 files changed, 540 insertions(+) create mode 100644 packages/disjoint-set/LICENSE create mode 100644 packages/disjoint-set/README.md create mode 100644 packages/disjoint-set/api-extractor.json create mode 100644 packages/disjoint-set/package.json create mode 100644 packages/disjoint-set/src/index.ts create mode 100644 packages/disjoint-set/test/main.test.ts create mode 100644 packages/disjoint-set/test/tsconfig.json create mode 100644 packages/disjoint-set/tpl.readme.md create mode 100644 packages/disjoint-set/tsconfig.json diff --git a/packages/disjoint-set/LICENSE b/packages/disjoint-set/LICENSE new file mode 100644 index 0000000000..8dada3edaf --- /dev/null +++ b/packages/disjoint-set/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/disjoint-set/README.md b/packages/disjoint-set/README.md new file mode 100644 index 0000000000..d491bad2fc --- /dev/null +++ b/packages/disjoint-set/README.md @@ -0,0 +1,95 @@ + + +# ![@thi.ng/disjoint-set](https://media.thi.ng/umbrella/banners-20230807/thing-disjoint-set.svg?58be4092) + +[![npm version](https://img.shields.io/npm/v/@thi.ng/disjoint-set.svg)](https://www.npmjs.com/package/@thi.ng/disjoint-set) +![npm downloads](https://img.shields.io/npm/dm/@thi.ng/disjoint-set.svg) +[![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 195 standalone projects, maintained as part +> of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo +> and anti-framework. +> +> 🚀 Please help me to work full-time on these projects by [sponsoring me on +> GitHub](https://github.com/sponsors/postspectacular). Thank you! ❤️ + +- [About](#about) +- [Status](#status) +- [Related packages](#related-packages) +- [Installation](#installation) +- [Dependencies](#dependencies) +- [API](#api) +- [Authors](#authors) +- [License](#license) + +## About + +TypedArray-based disjoint set implementation with quick union & path compression. + +## Status + +**STABLE** - used in production + +[Search or submit any issues for this package](https://github.com/thi-ng/umbrella/issues?q=%5Bdisjoint-set%5D+in%3Atitle) + +## Related packages + +- [@thi.ng/adjacency](https://github.com/thi-ng/umbrella/tree/develop/packages/adjacency) - Sparse & bitwise adjacency matrices, lists and selected traversal algorithms for directed & undirected graphs + +## Installation + +```bash +yarn add @thi.ng/disjoint-set +``` + +ESM import: + +```ts +import * as ds from "@thi.ng/disjoint-set"; +``` + +Browser ESM import: + +```html + +``` + +[JSDelivr documentation](https://www.jsdelivr.com/) + +For Node.js REPL: + +```js +const ds = await import("@thi.ng/disjoint-set"); +``` + +Package sizes (brotli'd, pre-treeshake): ESM: 420 bytes + +## Dependencies + +None + +## API + +[Generated API docs](https://docs.thi.ng/umbrella/disjoint-set/) + +TODO + +## Authors + +- [Karsten Schmidt](https://thi.ng) + +If this project contributes to an academic publication, please cite it as: + +```bibtex +@misc{thing-disjoint-set, + title = "@thi.ng/disjoint-set", + author = "Karsten Schmidt", + note = "https://thi.ng/disjoint-set", + year = 2019 +} +``` + +## License + +© 2019 - 2024 Karsten Schmidt // Apache License 2.0 diff --git a/packages/disjoint-set/api-extractor.json b/packages/disjoint-set/api-extractor.json new file mode 100644 index 0000000000..bc73f2cc02 --- /dev/null +++ b/packages/disjoint-set/api-extractor.json @@ -0,0 +1,3 @@ +{ + "extends": "../../api-extractor.json" +} diff --git a/packages/disjoint-set/package.json b/packages/disjoint-set/package.json new file mode 100644 index 0000000000..e46d19cacd --- /dev/null +++ b/packages/disjoint-set/package.json @@ -0,0 +1,79 @@ +{ + "name": "@thi.ng/disjoint-set", + "version": "1.0.0", + "description": "TypedArray-based disjoint set implementation with quick union & path compression", + "type": "module", + "module": "./index.js", + "typings": "./index.d.ts", + "sideEffects": false, + "repository": { + "type": "git", + "url": "https://github.com/thi-ng/umbrella.git" + }, + "homepage": "https://thi.ng/disjoint-set", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/postspectacular" + }, + { + "type": "patreon", + "url": "https://patreon.com/thing_umbrella" + } + ], + "author": "Karsten Schmidt (https://thi.ng)", + "license": "Apache-2.0", + "scripts": { + "build": "yarn build:esbuild && yarn build:decl", + "build:decl": "tsc --declaration --emitDeclarationOnly", + "build:esbuild": "esbuild --format=esm --platform=neutral --target=es2022 --tsconfig=tsconfig.json --outdir=. src/**/*.ts", + "clean": "bun ../../tools/src/clean-package.ts", + "doc": "typedoc --excludePrivate --excludeInternal --out doc src/index.ts", + "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose", + "doc:readme": "bun ../../tools/src/module-stats.ts && bun ../../tools/src/readme.ts", + "pub": "yarn npm publish --access public", + "test": "bun test", + "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts" + }, + "dependencies": {}, + "devDependencies": { + "@microsoft/api-extractor": "^7.47.0", + "esbuild": "^0.23.0", + "typedoc": "^0.26.3", + "typescript": "^5.5.3" + }, + "keywords": [ + "datastructure", + "disjoint-set", + "graph", + "set", + "query", + "typedarray", + "typescript" + ], + "publishConfig": { + "access": "public" + }, + "browser": { + "process": false, + "setTimeout": false + }, + "engines": { + "node": ">=18" + }, + "files": [ + "./*.js", + "./*.d.ts" + ], + "exports": { + ".": { + "default": "./index.js" + } + }, + "thi.ng": { + "related": [ + "adjacency" + ], + "year": 2019 + } +} diff --git a/packages/disjoint-set/src/index.ts b/packages/disjoint-set/src/index.ts new file mode 100644 index 0000000000..7a400736af --- /dev/null +++ b/packages/disjoint-set/src/index.ts @@ -0,0 +1,106 @@ +/** + * 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 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) { + const roots = (this.roots = new Uint32Array(n)); + this.ranks = new Uint8Array(n); + this.count = n; + for (let i = 0; i < n; i++) roots[i] = i; + } + + /** + * 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) { + 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: number, b: number) { + 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: number, b: number) { + 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: Map = 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; + } +} + +/** + * Creates a new {@link DisjointSet} with capacity `n`. + * + * @param n - + */ +export const defDisjointSet = (n: number) => new DisjointSet(n); diff --git a/packages/disjoint-set/test/main.test.ts b/packages/disjoint-set/test/main.test.ts new file mode 100644 index 0000000000..ff01ded154 --- /dev/null +++ b/packages/disjoint-set/test/main.test.ts @@ -0,0 +1,4 @@ +import { expect, test } from "bun:test"; +// import { } from "../src/index.js" + +test.todo("disjoint-set", () => {}); diff --git a/packages/disjoint-set/test/tsconfig.json b/packages/disjoint-set/test/tsconfig.json new file mode 100644 index 0000000000..10a781ee02 --- /dev/null +++ b/packages/disjoint-set/test/tsconfig.json @@ -0,0 +1,8 @@ +{ + "extends": "../../../tsconfig.json", + "compilerOptions": { + "types": ["bun-types"], + "noEmit": true + }, + "include": ["./**/*.ts"] +} diff --git a/packages/disjoint-set/tpl.readme.md b/packages/disjoint-set/tpl.readme.md new file mode 100644 index 0000000000..c7032b98b0 --- /dev/null +++ b/packages/disjoint-set/tpl.readme.md @@ -0,0 +1,35 @@ + + + + +## About + +{{pkg.description}} + +{{meta.status}} + +{{repo.supportPackages}} + +{{repo.relatedPackages}} + +{{meta.blogPosts}} + +## Installation + +{{pkg.install}} + +{{pkg.size}} + +## Dependencies + +{{pkg.deps}} + +{{repo.examples}} + +## API + +{{pkg.docs}} + +TODO + + diff --git a/packages/disjoint-set/tsconfig.json b/packages/disjoint-set/tsconfig.json new file mode 100644 index 0000000000..1cd5465cf2 --- /dev/null +++ b/packages/disjoint-set/tsconfig.json @@ -0,0 +1,9 @@ +{ + "extends": "../../tsconfig.json", + "compilerOptions": { + "outDir": "." + }, + "include": [ + "./src/**/*.ts" + ] +}