rbush-rs 0.1.0

package/README.md

@@ -0,0 +1,162 @@
+# rbush-rs
+A high-performance(>5x faster), 100% Rust port of [RBush](https://github.com/mourner/rbush) spatial index library, compiled to WebAssembly.
+
+`rbush-rs` is designed to be a near drop-in replacement for `rbush`, offering significant performance improvements for bulk loading and searching massive datasets.
+
+```diff
++ Import { RBush } from 'rbush-rs';
+- Import { RBush } from 'rbush';
+```
+
+## Benchmark
+
+Tests performed on a dataset of 10,000 rectangles.
+
+| Operation | JS (rbush) | WASM (rbush-rs) | Speedup |
+| --- | --- | --- | --- |
+| **Bulk Load (Hybrid)** | 20.23 ms | **3.60 ms** | **~5.6x Faster** |
+| **Insert (1000 items)** | 36.58 ms | **4.04 ms** | **~9.1x Faster** |
+| **Remove (1000 items)** | 58.03 ms | **7.85 ms** | **~7.4x Faster** |
+| **Search** | 0.042 ms | **0.027 ms** | **~1.6x Faster** |
+| **Collides** | 0.003 ms | 0.003 ms | **1x Faster** |
+| **Clear** | 0.001 ms | 0.001 ms | **1x Faster** |
+
+*\*Standard load is slower due to the overhead of reading JS objects into WASM. Use Hybrid Load for maximum performance.*
+
+## Installation
+You can install `rbush-rs` via:
+
+### npm
+```bash
+npm install rbush-rs
+```
+
+### pnpm
+```bash
+pnpm install rbush-rs
+```
+
+### yarn
+```bash
+yarn add rbush-rs
+```
+
+
+## Usage
+
+### The "Drop-in" Replacement
+
+Use this mode if you want to switch libraries with minimal code changes. It accepts the same data format as the original `rbush`.
+
+```javascript
+import { RBush } from 'rbush-rs';
+
+// Initialize (max entries per node, default 9)
+const tree = new RBush(9);
+
+// Load standard data (Array of objects with minX, minY, maxX, maxY)
+const items = [
+    { minX: 10, minY: 10, maxX: 20, maxY: 20, id: 'a' },
+    { minX: 50, minY: 50, maxX: 60, maxY: 60, id: 'b' }
+];
+tree.load(items);
+
+// Search
+const results = tree.search({ minX: 0, minY: 0, maxX: 30, maxY: 30 });
+console.log(results); // [{ minX: 10, ... }]
+
+```
+
+### The "Hybrid" Load (Recommended for MAX Speed)
+
+To unlock the 5-6x load speedup, pass the coordinates as a `Float64Array` alongside your items. This allows Rust to sort the data instantly without expensive JavaScript object lookups.
+
+```javascript
+import { RBush } from 'rbush-rs';
+
+const tree = new RBush(9);
+const items = [];
+const count = 10000;
+
+// Create a flat array for coordinates [minX, minY, maxX, maxY, minX...]
+// Size = count * 4
+const flatCoords = new Float64Array(count * 4);
+
+for(let i = 0; i < count; i++) {
+    const item = { minX: Math.random() * 100, minY: Math.random() * 100, maxX: ..., maxY: ..., id: i };
+    
+    // standard items array
+    items.push(item);
+
+    // flat array
+    flatCoords[i*4]     = item.minX;
+    flatCoords[i*4 + 1] = item.minY;
+    flatCoords[i*4 + 2] = item.maxX;
+    flatCoords[i*4 + 3] = item.maxY;
+}
+
+// Load both at once
+tree.loadHybrid(flatCoords, items);
+
+// Search is exactly the same
+const results = tree.search({ minX: 0, minY: 0, maxX: 50, maxY: 50 });
+
+```
+
+### Other Operations
+
+All operations below work regardless of how you loaded the data (Standard or Hybrid).
+
+#### Single Insertion
+
+`rbush-rs` is highly optimized for dynamic updates, performing ~9x faster than JS.
+
+```javascript
+const item = { minX: 20, minY: 20, maxX: 30, maxY: 30, id: 'c' };
+tree.insert(item);
+```
+
+#### Removal
+
+Removal is ~7x faster than JS. The item object passed must match the one in the tree (by reference equality).
+
+```javascript
+tree.remove(item);
+```
+
+#### Collision Detection
+
+Checks if there are any items in the bounding box. Faster than `search` if you don't need the actual items.
+
+```javascript
+const hasCollision = tree.collides({ minX: 10, minY: 10, maxX: 20, maxY: 20 });
+// returns true or false
+```
+
+#### Retrieve All Items
+
+Returns all items currently stored in the tree.
+
+```javascript
+const allItems = tree.all();
+```
+
+#### Clear Tree
+
+Removes all items and resets the tree.
+
+```javascript
+tree.clear();
+```
+
+## 🔧 API Reference
+
+* **`new RBush(maxEntries?: number)`**: Creates a new tree.
+* **`load(items: array)`**: Bulk loads standard JS objects.
+* **`loadHybrid(coords: Float64Array, items: array)`**: High-performance bulk load.
+* **`insert(item: object)`**: Inserts a single item.
+* **`remove(item: object)`**: Removes a specific item.
+* **`search(bbox: object)`**: Returns an array of items intersecting the bbox.
+* **`collides(bbox: object)`**: Returns `true` if any item intersects the bbox.
+* **`all()`**: Returns all items in the tree.
+* **`clear()`**: Removes all items.

package/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "rbush-rs",
+  "type": "module",
+  "version": "0.1.0",
+  "files": [
+    "rbush_rs_bg.wasm",
+    "rbush_rs.js",
+    "rbush_rs.d.ts"
+  ],
+  "main": "rbush_rs.js",
+  "types": "rbush_rs.d.ts",
+  "sideEffects": [
+    "./snippets/*"
+  ]
+}

package/rbush_rs.d.ts

@@ -0,0 +1,59 @@
+/* tslint:disable */
+/* eslint-disable */
+
+export class RBush {
+    free(): void;
+    [Symbol.dispose](): void;
+    all(): Array<any>;
+    clear(): void;
+    collides(bbox_js: any): boolean;
+    insert(item: any): void;
+    load(data: Array<any>): void;
+    loadHybrid(fast_coords: Float64Array, items: Array<any>): void;
+    constructor(max_entries?: number | null);
+    remove(item: any): void;
+    search(bbox_js: any): Array<any>;
+}
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_rbush_free: (a: number, b: number) => void;
+    readonly rbush_all: (a: number) => any;
+    readonly rbush_clear: (a: number) => void;
+    readonly rbush_collides: (a: number, b: any) => number;
+    readonly rbush_insert: (a: number, b: any) => void;
+    readonly rbush_load: (a: number, b: any) => void;
+    readonly rbush_loadHybrid: (a: number, b: number, c: number, d: any) => void;
+    readonly rbush_new: (a: number) => number;
+    readonly rbush_remove: (a: number, b: any) => void;
+    readonly rbush_search: (a: number, b: any) => any;
+    readonly __wbindgen_exn_store: (a: number) => void;
+    readonly __externref_table_alloc: () => number;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;

package/rbush_rs.js

@@ -0,0 +1,303 @@
+/* @ts-self-types="./rbush_rs.d.ts" */
+
+export class RBush {
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        RBushFinalization.unregister(this);
+        return ptr;
+    }
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_rbush_free(ptr, 0);
+    }
+    /**
+     * @returns {Array<any>}
+     */
+    all() {
+        const ret = wasm.rbush_all(this.__wbg_ptr);
+        return ret;
+    }
+    clear() {
+        wasm.rbush_clear(this.__wbg_ptr);
+    }
+    /**
+     * @param {any} bbox_js
+     * @returns {boolean}
+     */
+    collides(bbox_js) {
+        const ret = wasm.rbush_collides(this.__wbg_ptr, bbox_js);
+        return ret !== 0;
+    }
+    /**
+     * @param {any} item
+     */
+    insert(item) {
+        wasm.rbush_insert(this.__wbg_ptr, item);
+    }
+    /**
+     * @param {Array<any>} data
+     */
+    load(data) {
+        wasm.rbush_load(this.__wbg_ptr, data);
+    }
+    /**
+     * @param {Float64Array} fast_coords
+     * @param {Array<any>} items
+     */
+    loadHybrid(fast_coords, items) {
+        const ptr0 = passArrayF64ToWasm0(fast_coords, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        wasm.rbush_loadHybrid(this.__wbg_ptr, ptr0, len0, items);
+    }
+    /**
+     * @param {number | null} [max_entries]
+     */
+    constructor(max_entries) {
+        const ret = wasm.rbush_new(isLikeNone(max_entries) ? 0x100000001 : (max_entries) >>> 0);
+        this.__wbg_ptr = ret >>> 0;
+        RBushFinalization.register(this, this.__wbg_ptr, this);
+        return this;
+    }
+    /**
+     * @param {any} item
+     */
+    remove(item) {
+        wasm.rbush_remove(this.__wbg_ptr, item);
+    }
+    /**
+     * @param {any} bbox_js
+     * @returns {Array<any>}
+     */
+    search(bbox_js) {
+        const ret = wasm.rbush_search(this.__wbg_ptr, bbox_js);
+        return ret;
+    }
+}
+if (Symbol.dispose) RBush.prototype[Symbol.dispose] = RBush.prototype.free;
+
+function __wbg_get_imports() {
+    const import0 = {
+        __proto__: null,
+        __wbg___wbindgen_jsval_eq_11888390b0186270: function(arg0, arg1) {
+            const ret = arg0 === arg1;
+            return ret;
+        },
+        __wbg___wbindgen_number_get_8ff4255516ccad3e: function(arg0, arg1) {
+            const obj = arg1;
+            const ret = typeof(obj) === 'number' ? obj : undefined;
+            getDataViewMemory0().setFloat64(arg0 + 8 * 1, isLikeNone(ret) ? 0 : ret, true);
+            getDataViewMemory0().setInt32(arg0 + 4 * 0, !isLikeNone(ret), true);
+        },
+        __wbg___wbindgen_throw_be289d5034ed271b: function(arg0, arg1) {
+            throw new Error(getStringFromWasm0(arg0, arg1));
+        },
+        __wbg_get_9b94d73e6221f75c: function(arg0, arg1) {
+            const ret = arg0[arg1 >>> 0];
+            return ret;
+        },
+        __wbg_get_b3ed3ad4be2bc8ac: function() { return handleError(function (arg0, arg1) {
+            const ret = Reflect.get(arg0, arg1);
+            return ret;
+        }, arguments); },
+        __wbg_length_35a7bace40f36eac: function(arg0) {
+            const ret = arg0.length;
+            return ret;
+        },
+        __wbg_new_3eb36ae241fe6f44: function() {
+            const ret = new Array();
+            return ret;
+        },
+        __wbg_push_8ffdcb2063340ba5: function(arg0, arg1) {
+            const ret = arg0.push(arg1);
+            return ret;
+        },
+        __wbindgen_cast_0000000000000001: function(arg0, arg1) {
+            // Cast intrinsic for `Ref(String) -> Externref`.
+            const ret = getStringFromWasm0(arg0, arg1);
+            return ret;
+        },
+        __wbindgen_init_externref_table: function() {
+            const table = wasm.__wbindgen_externrefs;
+            const offset = table.grow(4);
+            table.set(0, undefined);
+            table.set(offset + 0, undefined);
+            table.set(offset + 1, null);
+            table.set(offset + 2, true);
+            table.set(offset + 3, false);
+        },
+    };
+    return {
+        __proto__: null,
+        "./rbush_rs_bg.js": import0,
+    };
+}
+
+const RBushFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_rbush_free(ptr >>> 0, 1));
+
+function addToExternrefTable0(obj) {
+    const idx = wasm.__externref_table_alloc();
+    wasm.__wbindgen_externrefs.set(idx, obj);
+    return idx;
+}
+
+let cachedDataViewMemory0 = null;
+function getDataViewMemory0() {
+    if (cachedDataViewMemory0 === null || cachedDataViewMemory0.buffer.detached === true || (cachedDataViewMemory0.buffer.detached === undefined && cachedDataViewMemory0.buffer !== wasm.memory.buffer)) {
+        cachedDataViewMemory0 = new DataView(wasm.memory.buffer);
+    }
+    return cachedDataViewMemory0;
+}
+
+let cachedFloat64ArrayMemory0 = null;
+function getFloat64ArrayMemory0() {
+    if (cachedFloat64ArrayMemory0 === null || cachedFloat64ArrayMemory0.byteLength === 0) {
+        cachedFloat64ArrayMemory0 = new Float64Array(wasm.memory.buffer);
+    }
+    return cachedFloat64ArrayMemory0;
+}
+
+function getStringFromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    return decodeText(ptr, len);
+}
+
+let cachedUint8ArrayMemory0 = null;
+function getUint8ArrayMemory0() {
+    if (cachedUint8ArrayMemory0 === null || cachedUint8ArrayMemory0.byteLength === 0) {
+        cachedUint8ArrayMemory0 = new Uint8Array(wasm.memory.buffer);
+    }
+    return cachedUint8ArrayMemory0;
+}
+
+function handleError(f, args) {
+    try {
+        return f.apply(this, args);
+    } catch (e) {
+        const idx = addToExternrefTable0(e);
+        wasm.__wbindgen_exn_store(idx);
+    }
+}
+
+function isLikeNone(x) {
+    return x === undefined || x === null;
+}
+
+function passArrayF64ToWasm0(arg, malloc) {
+    const ptr = malloc(arg.length * 8, 8) >>> 0;
+    getFloat64ArrayMemory0().set(arg, ptr / 8);
+    WASM_VECTOR_LEN = arg.length;
+    return ptr;
+}
+
+let cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+cachedTextDecoder.decode();
+const MAX_SAFARI_DECODE_BYTES = 2146435072;
+let numBytesDecoded = 0;
+function decodeText(ptr, len) {
+    numBytesDecoded += len;
+    if (numBytesDecoded >= MAX_SAFARI_DECODE_BYTES) {
+        cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+        cachedTextDecoder.decode();
+        numBytesDecoded = len;
+    }
+    return cachedTextDecoder.decode(getUint8ArrayMemory0().subarray(ptr, ptr + len));
+}
+
+let WASM_VECTOR_LEN = 0;
+
+let wasmModule, wasm;
+function __wbg_finalize_init(instance, module) {
+    wasm = instance.exports;
+    wasmModule = module;
+    cachedDataViewMemory0 = null;
+    cachedFloat64ArrayMemory0 = null;
+    cachedUint8ArrayMemory0 = null;
+    wasm.__wbindgen_start();
+    return wasm;
+}
+
+async function __wbg_load(module, imports) {
+    if (typeof Response === 'function' && module instanceof Response) {
+        if (typeof WebAssembly.instantiateStreaming === 'function') {
+            try {
+                return await WebAssembly.instantiateStreaming(module, imports);
+            } catch (e) {
+                const validResponse = module.ok && expectedResponseType(module.type);
+
+                if (validResponse && module.headers.get('Content-Type') !== 'application/wasm') {
+                    console.warn("`WebAssembly.instantiateStreaming` failed because your server does not serve Wasm with `application/wasm` MIME type. Falling back to `WebAssembly.instantiate` which is slower. Original error:\n", e);
+
+                } else { throw e; }
+            }
+        }
+
+        const bytes = await module.arrayBuffer();
+        return await WebAssembly.instantiate(bytes, imports);
+    } else {
+        const instance = await WebAssembly.instantiate(module, imports);
+
+        if (instance instanceof WebAssembly.Instance) {
+            return { instance, module };
+        } else {
+            return instance;
+        }
+    }
+
+    function expectedResponseType(type) {
+        switch (type) {
+            case 'basic': case 'cors': case 'default': return true;
+        }
+        return false;
+    }
+}
+
+function initSync(module) {
+    if (wasm !== undefined) return wasm;
+
+
+    if (module !== undefined) {
+        if (Object.getPrototypeOf(module) === Object.prototype) {
+            ({module} = module)
+        } else {
+            console.warn('using deprecated parameters for `initSync()`; pass a single object instead')
+        }
+    }
+
+    const imports = __wbg_get_imports();
+    if (!(module instanceof WebAssembly.Module)) {
+        module = new WebAssembly.Module(module);
+    }
+    const instance = new WebAssembly.Instance(module, imports);
+    return __wbg_finalize_init(instance, module);
+}
+
+async function __wbg_init(module_or_path) {
+    if (wasm !== undefined) return wasm;
+
+
+    if (module_or_path !== undefined) {
+        if (Object.getPrototypeOf(module_or_path) === Object.prototype) {
+            ({module_or_path} = module_or_path)
+        } else {
+            console.warn('using deprecated parameters for the initialization function; pass a single object instead')
+        }
+    }
+
+    if (module_or_path === undefined) {
+        module_or_path = new URL('rbush_rs_bg.wasm', import.meta.url);
+    }
+    const imports = __wbg_get_imports();
+
+    if (typeof module_or_path === 'string' || (typeof Request === 'function' && module_or_path instanceof Request) || (typeof URL === 'function' && module_or_path instanceof URL)) {
+        module_or_path = fetch(module_or_path);
+    }
+
+    const { instance, module } = await __wbg_load(await module_or_path, imports);
+
+    return __wbg_finalize_init(instance, module);
+}
+
+export { initSync, __wbg_init as default };