diff --git a/packages/sparse-set/LICENSE b/packages/sparse-set/LICENSE new file mode 100644 index 0000000000..8dada3edaf --- /dev/null +++ b/packages/sparse-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/sparse-set/README.md b/packages/sparse-set/README.md new file mode 100644 index 0000000000..3a31e891fc --- /dev/null +++ b/packages/sparse-set/README.md @@ -0,0 +1,135 @@ + + +# ![@thi.ng/sparse-set](https://media.thi.ng/umbrella/banners-20230807/thing-sparse-set.svg?eb275e55) + +[![npm version](https://img.shields.io/npm/v/@thi.ng/sparse-set.svg)](https://www.npmjs.com/package/@thi.ng/sparse-set) +![npm downloads](https://img.shields.io/npm/dm/@thi.ng/sparse-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 194 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) + - [SparseSet8/16/32](#sparseset81632) +- [Status](#status) +- [Related packages](#related-packages) +- [Installation](#installation) +- [Dependencies](#dependencies) +- [API](#api) +- [Authors](#authors) +- [License](#license) + +## About + +TypedArray-based sparse set implementations with extended ES Set API. + +### SparseSet8/16/32 + +[Sparse sets](https://research.swtch.com/sparse) provide super fast +(approx. 4x faster than the native `Set` impl) insertion & lookups for +numeric values in the interval `[0..n)` . The implementation in this +package provides most of the ES6 Set API and internally relies on 2 uint +typed arrays, with the actual backing type dependent on `n`. + +Furthermore, unless (or until) values are being removed from the set, +they retain their original insertion order. For some use cases (e.g. +deduplication of values), this property can be very useful. + +```ts +import { defSparseSet } from "@thi.ng/sparse-set"; + +// create sparse set for value range 0 - 99 (uint8 backed) +const a = defSparseSet(100); +a.into([99, 42, 66, 23, 66, 42]); +// SparseSet8 { 99, 42, 66, 23 } + +a.has(66) +// true + +// sparse sets are iterable +[...a] +// [ 99, 42, 66, 23 ] + +// attempting to add out-of-range values will fail +a.add(100) +// SparseSet8 { 99, 42, 66, 23 } + +// create sparse set for 16 bit value range 0 - 0xffff (uint16 backed) +const b = defSparseSet(0x10000); +// SparseSet16 {} +``` + +## Status + +**STABLE** - used in production + +[Search or submit any issues for this package](https://github.com/thi-ng/umbrella/issues?q=%5Bsparse-set%5D+in%3Atitle) + +## Related packages + +- [@thi.ng/associative](https://github.com/thi-ng/umbrella/tree/develop/packages/associative) - ES Map/Set-compatible implementations with customizable equality semantics & supporting operations + +## Installation + +```bash +yarn add @thi.ng/sparse-set +``` + +ESM import: + +```ts +import * as ss from "@thi.ng/sparse-set"; +``` + +Browser ESM import: + +```html + +``` + +[JSDelivr documentation](https://www.jsdelivr.com/) + +For Node.js REPL: + +```js +const ss = await import("@thi.ng/sparse-set"); +``` + +Package sizes (brotli'd, pre-treeshake): ESM: 988 bytes + +## Dependencies + +- [@thi.ng/api](https://github.com/thi-ng/umbrella/tree/develop/packages/api) +- [@thi.ng/associative](https://github.com/thi-ng/umbrella/tree/develop/packages/associative) +- [@thi.ng/checks](https://github.com/thi-ng/umbrella/tree/develop/packages/checks) +- [@thi.ng/errors](https://github.com/thi-ng/umbrella/tree/develop/packages/errors) + +## API + +[Generated API docs](https://docs.thi.ng/umbrella/sparse-set/) + +TODO + +## Authors + +- [Karsten Schmidt](https://thi.ng) + +If this project contributes to an academic publication, please cite it as: + +```bibtex +@misc{thing-sparse-set, + title = "@thi.ng/sparse-set", + author = "Karsten Schmidt", + note = "https://thi.ng/sparse-set", + year = 2019 +} +``` + +## License + +© 2019 - 2024 Karsten Schmidt // Apache License 2.0 diff --git a/packages/sparse-set/api-extractor.json b/packages/sparse-set/api-extractor.json new file mode 100644 index 0000000000..bc73f2cc02 --- /dev/null +++ b/packages/sparse-set/api-extractor.json @@ -0,0 +1,3 @@ +{ + "extends": "../../api-extractor.json" +} diff --git a/packages/sparse-set/package.json b/packages/sparse-set/package.json new file mode 100644 index 0000000000..ee04198e20 --- /dev/null +++ b/packages/sparse-set/package.json @@ -0,0 +1,86 @@ +{ + "name": "@thi.ng/sparse-set", + "version": "1.0.0", + "description": "TypedArray-based sparse set implementations with extended ES Set API", + "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/sparse-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": { + "@thi.ng/api": "^8.11.6", + "@thi.ng/associative": "^6.3.65", + "@thi.ng/checks": "^3.6.8", + "@thi.ng/errors": "^2.5.12" + }, + "devDependencies": { + "@microsoft/api-extractor": "^7.47.0", + "esbuild": "^0.23.0", + "typedoc": "^0.26.3", + "typescript": "^5.5.3" + }, + "keywords": [ + "binary", + "datastructure", + "identifier", + "iterator", + "sparse", + "set", + "typedarray", + "typescript", + "unique" + ], + "publishConfig": { + "access": "public" + }, + "browser": { + "process": false, + "setTimeout": false + }, + "engines": { + "node": ">=18" + }, + "files": [ + "./*.js", + "./*.d.ts" + ], + "exports": { + ".": { + "default": "./index.js" + } + }, + "thi.ng": { + "related": [ + "associative" + ], + "year": 2019 + } +} diff --git a/packages/sparse-set/src/index.ts b/packages/sparse-set/src/index.ts new file mode 100644 index 0000000000..47a447b9cc --- /dev/null +++ b/packages/sparse-set/src/index.ts @@ -0,0 +1,264 @@ +import type { Fn3, IEquiv, Pair, UIntArray } from "@thi.ng/api"; +import type { IEquivSet } from "@thi.ng/associative/api"; +import { dissoc } from "@thi.ng/associative/dissoc"; +import { __inspectable } from "@thi.ng/associative/internal/inspect"; +import { into } from "@thi.ng/associative/into"; +import { isNumber } from "@thi.ng/checks/is-number"; +import { illegalArgs } from "@thi.ng/errors/illegal-arguments"; + +interface SparseSetProps { + dense: UIntArray; + sparse: UIntArray; + n: number; +} + +/** @internal */ +const __private = new WeakMap, SparseSetProps>(); + +/** @internal */ +const __fail = () => illegalArgs(`dense & sparse arrays must be of same size`); + +/** + * After "An Efficient Representation for Sparse Sets" Preston Briggs and Linda + * Torczon (1993) + * + * - https://research.swtch.com/sparse + * - https://programmingpraxis.com/2012/03/09/sparse-sets/ + * - https://blog.molecular-matters.com/2013/07/24/adventures-in-data-oriented-design-part-3c-external-references/ + */ +@__inspectable +export abstract class ASparseSet + extends Set + implements IEquiv +{ + protected constructor(dense: T, sparse: T) { + super(); + __private.set(this, { dense, sparse, n: 0 }); + } + + [Symbol.iterator]() { + return this.keys(); + } + + get size(): number { + return __private.get(this)!.n; + } + + get capacity(): number { + return __private.get(this)!.dense.length; + } + + clear() { + __private.get(this)!.n = 0; + } + + equiv(o: any) { + if (this === o) { + return true; + } + if (!(o instanceof Set) || this.size !== o.size) { + return false; + } + const $this = __private.get(this)!; + const d = $this.dense; + for (let i = $this.n; i-- > 0; ) { + if (!o.has(d[i])) { + return false; + } + } + return true; + } + + add(key: number) { + const $this = __private.get(this)!; + const { dense, sparse, n } = $this; + const max = dense.length; + const i = sparse[key]; + if (key < max && n < max && !(i < n && dense[i] === key)) { + dense[n] = key; + sparse[key] = n; + $this.n++; + } + return this; + } + + delete(key: number) { + const $this = __private.get(this)!; + const { dense, sparse } = $this; + const i = sparse[key]; + if (i < $this.n && dense[i] === key) { + const j = dense[--$this.n]; + dense[i] = j; + sparse[j] = i; + return true; + } + return false; + } + + has(key: number): boolean { + const $this = __private.get(this)!; + const i = $this.sparse[key]; + return i < $this.n && $this.dense[i] === key; + } + + get(key: number, notFound = -1) { + return this.has(key) ? key : notFound; + } + + first() { + const $this = __private.get(this)!; + return $this.n ? $this.dense[0] : undefined; + } + + into(keys: Iterable) { + return into(this, keys); + } + + disj(keys: Iterable) { + return dissoc(this, keys); + } + + forEach(fn: Fn3, void>, thisArg?: any) { + const $this = __private.get(this)!; + const d = $this.dense; + const n = $this.n; + for (let i = 0; i < n; i++) { + const v = d[i]; + fn.call(thisArg, v, v, this); + } + } + + *entries(): IterableIterator> { + const { dense, n } = __private.get(this)!; + for (let i = 0; i < n; i++) { + yield [dense[i], dense[i]]; + } + } + + *keys(): IterableIterator { + const { dense, n } = __private.get(this)!; + for (let i = 0; i < n; i++) { + yield dense[i]; + } + } + + values() { + return this.keys(); + } + + protected __copyTo>(dest: S) { + const $this = __private.get(this)!; + const $c = __private.get(dest)!; + $c.dense = $this.dense.slice(); + $c.sparse = $this.sparse.slice(); + $c.n = $this.n; + return dest; + } +} + +export class SparseSet8 + extends ASparseSet + implements IEquivSet +{ + constructor(dense: Uint8Array, sparse: Uint8Array); + constructor(n: number); + constructor(n: number | Uint8Array, sparse?: Uint8Array) { + isNumber(n) + ? super(new Uint8Array(n), new Uint8Array(n)) + : n.length === sparse!.length + ? super(n, sparse!) + : __fail(); + } + + get [Symbol.species]() { + return SparseSet8; + } + + get [Symbol.toStringTag]() { + return "SparseSet8"; + } + + copy() { + return this.__copyTo(new SparseSet8(0)); + } + + empty() { + return new SparseSet8(this.capacity); + } +} + +export class SparseSet16 + extends ASparseSet + implements IEquivSet +{ + constructor(dense: Uint16Array, sparse: Uint16Array); + constructor(n: number); + constructor(n: number | Uint16Array, sparse?: Uint16Array) { + isNumber(n) + ? super(new Uint16Array(n), new Uint16Array(n)) + : n.length === sparse!.length + ? super(n, sparse!) + : __fail(); + } + + get [Symbol.species]() { + return SparseSet16; + } + + get [Symbol.toStringTag]() { + return "SparseSet16"; + } + + copy() { + return this.__copyTo(new SparseSet16(0)); + } + + empty() { + return new SparseSet16(this.capacity); + } +} + +export class SparseSet32 + extends ASparseSet + implements IEquivSet +{ + constructor(dense: Uint32Array, sparse: Uint32Array); + constructor(n: number); + constructor(n: number | Uint32Array, sparse?: Uint32Array) { + isNumber(n) + ? super(new Uint32Array(n), new Uint32Array(n)) + : n.length === sparse!.length + ? super(n, sparse!) + : __fail(); + } + + get [Symbol.species]() { + return SparseSet32; + } + + get [Symbol.toStringTag]() { + return "SparseSet32"; + } + + copy() { + return this.__copyTo(new SparseSet32(0)); + } + + empty() { + return new SparseSet32(this.capacity); + } +} + +/** + * Creates a new sparse set with given max. capacity (max ID + 1) and + * chooses most memory efficient implementation, e.g. if `n` <= 256 + * returns a {@link SparseSet8} instance. + * + * @param n - max capacity, ID range: [0...n) + */ +export const defSparseSet = (n: number) => + n <= 0x100 + ? new SparseSet8(n) + : n <= 0x10000 + ? new SparseSet16(n) + : new SparseSet32(n); diff --git a/packages/sparse-set/test/main.test.ts b/packages/sparse-set/test/main.test.ts new file mode 100644 index 0000000000..ee57a9e2dd --- /dev/null +++ b/packages/sparse-set/test/main.test.ts @@ -0,0 +1,80 @@ +import { isSet } from "@thi.ng/checks"; +import { equiv } from "@thi.ng/equiv"; +import { beforeEach, expect, test } from "bun:test"; +import { + SparseSet16, + SparseSet32, + SparseSet8, + defSparseSet, +} from "../src/index.js"; + +let set: SparseSet8; + +beforeEach(() => { + set = new SparseSet8(8); +}); + +test("factory / max value", () => { + let a = defSparseSet(0x100); + a.into([0xff, 0x100]); + expect(a instanceof SparseSet8).toBeTrue(); + expect([...a]).toEqual([0xff]); + + a = defSparseSet(0x10000); + a.into([0xffff, 0x10000]); + expect(a instanceof SparseSet16).toBeTrue(); + expect([...a]).toEqual([0xffff]); + + a = defSparseSet(0x10001); + a.into([0x10000, 0x10001]); + expect(a instanceof SparseSet32).toBeTrue(); + expect([...a]).toEqual([0x10000]); +}); + +test("ctor(n)", () => { + expect(isSet(set)).toBeTrue(); + expect(set.size).toBe(0); + expect(set.capacity).toBe(8); +}); + +test("ctor(arrays)", () => { + const d = new Uint8Array(8); + const s = new Uint8Array(8); + set = new SparseSet8(d, s); + expect(set.size).toBe(0); + expect(set.capacity).toBe(8); + expect(() => new SparseSet8(new Uint8Array(4), s)).toThrow(); +}); + +test("add", () => { + expect( + equiv( + set.into([1, 4, 3, 7, 9, 2, 0, 1, 2]), + new Set([0, 1, 2, 3, 4, 7]) + ) + ).toBeTrue(); +}); + +test("delete", () => { + set.into([1, 4, 3, 7, 9, 2, 0, 1, 2]); + expect(set.delete(4)).toBeTrue(); + expect(equiv(set, new Set([0, 1, 2, 3, 7]))).toBeTrue(); + expect(set.delete(0)).toBeTrue(); + expect(equiv(set, new Set([1, 2, 3, 7]))).toBeTrue(); + expect(set.delete(7)).toBeTrue(); + expect(equiv(set, new Set([1, 2, 3]))).toBeTrue(); + expect(set.delete(7)).toBeFalse(); + expect(set.delete(4)).toBeFalse(); + set.add(4); + expect(equiv(set, new Set([1, 2, 3, 4]))).toBeTrue(); +}); + +test("has", () => { + expect(set.has(0)).toBeFalse(); + set.add(0); + set.add(0); + expect(set.has(0)).toBeTrue(); + set.delete(0); + expect(set.has(0)).toBeFalse(); + set.into([3, 1, 2]); +}); diff --git a/packages/sparse-set/test/tsconfig.json b/packages/sparse-set/test/tsconfig.json new file mode 100644 index 0000000000..10a781ee02 --- /dev/null +++ b/packages/sparse-set/test/tsconfig.json @@ -0,0 +1,8 @@ +{ + "extends": "../../../tsconfig.json", + "compilerOptions": { + "types": ["bun-types"], + "noEmit": true + }, + "include": ["./**/*.ts"] +} diff --git a/packages/sparse-set/tpl.readme.md b/packages/sparse-set/tpl.readme.md new file mode 100644 index 0000000000..5fe1ec3225 --- /dev/null +++ b/packages/sparse-set/tpl.readme.md @@ -0,0 +1,71 @@ + + + + +## About + +{{pkg.description}} + +### SparseSet8/16/32 + +[Sparse sets](https://research.swtch.com/sparse) provide super fast +(approx. 4x faster than the native `Set` impl) insertion & lookups for +numeric values in the interval `[0..n)` . The implementation in this +package provides most of the ES6 Set API and internally relies on 2 uint +typed arrays, with the actual backing type dependent on `n`. + +Furthermore, unless (or until) values are being removed from the set, +they retain their original insertion order. For some use cases (e.g. +deduplication of values), this property can be very useful. + +```ts +import { defSparseSet } from "@thi.ng/sparse-set"; + +// create sparse set for value range 0 - 99 (uint8 backed) +const a = defSparseSet(100); +a.into([99, 42, 66, 23, 66, 42]); +// SparseSet8 { 99, 42, 66, 23 } + +a.has(66) +// true + +// sparse sets are iterable +[...a] +// [ 99, 42, 66, 23 ] + +// attempting to add out-of-range values will fail +a.add(100) +// SparseSet8 { 99, 42, 66, 23 } + +// create sparse set for 16 bit value range 0 - 0xffff (uint16 backed) +const b = defSparseSet(0x10000); +// SparseSet16 {} +``` + +{{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/sparse-set/tsconfig.json b/packages/sparse-set/tsconfig.json new file mode 100644 index 0000000000..1cd5465cf2 --- /dev/null +++ b/packages/sparse-set/tsconfig.json @@ -0,0 +1,9 @@ +{ + "extends": "../../tsconfig.json", + "compilerOptions": { + "outDir": "." + }, + "include": [ + "./src/**/*.ts" + ] +}