fastquadtree 0.4.0__cp38-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl

fastquadtree/__init__.py

@@ -0,0 +1,388 @@
+from __future__ import annotations
+
+from typing import Any, Iterable, List, Optional, Tuple, overload
+from typing import Literal
+
+# Compiled Rust module is provided by maturin (tool.maturin.module-name)
+from ._native import QuadTree as _RustQuadTree
+from ._bimap import BiMap  # type: ignore[attr-defined]
+from ._item import Item
+
+Bounds = Tuple[float, float, float, float]
+"""Axis-aligned rectangle as (min_x, min_y, max_x, max_y)."""
+
+Point = Tuple[float, float]
+"""2D point as (x, y)."""
+
+_IdCoord = Tuple[int, float, float]
+"""Result tuple as (id, x, y)."""
+
+
+class QuadTree:
+    """
+    High-level Python wrapper over the Rust quadtree engine.
+
+    The quadtree stores points with integer IDs. You may attach an arbitrary
+    Python object per ID when object tracking is enabled.
+
+    Performance characteristics:
+        Inserts: average O(log n)
+        Rect queries: average O(log n + k) where k is matches returned
+        Nearest neighbor: average O(log n)
+
+    Thread-safety:
+        Instances are not thread-safe. Use external synchronization if you
+        mutate the same tree from multiple threads.
+
+    Args:
+        bounds: World bounds as (min_x, min_y, max_x, max_y).
+        capacity: Max number of points per node before splitting.
+        max_depth: Optional max tree depth. If omitted, engine decides.
+        track_objects: Enable id <-> object mapping inside Python.
+        start_id: Starting auto-assigned id when you omit id on insert.
+
+    Raises:
+        ValueError: If parameters are invalid or inserts are out of bounds.
+    """
+
+    __slots__ = ("_native", "_items", "_next_id", "_count", "_bounds")
+
+    def __init__(
+        self,
+        bounds: Bounds,
+        capacity: int,
+        *,
+        max_depth: Optional[int] = None,
+        track_objects: bool = False,
+        start_id: int = 1,
+    ):
+        if max_depth is None:
+            self._native = _RustQuadTree(bounds, capacity)
+        else:
+            self._native = _RustQuadTree(bounds, capacity, max_depth=max_depth)
+        self._items: Optional[BiMap] = BiMap() if track_objects else None
+        self._next_id: int = int(start_id)
+        self._count: int = 0
+        self._bounds = bounds
+
+    # ---------- inserts ----------
+
+    def insert(self, xy: Point, *, id: Optional[int] = None, obj: Any = None) -> int:
+        """
+        Insert a single point.
+
+        Args:
+            xy: Point (x, y).
+            id: Optional integer id. If None, an auto id is assigned.
+            obj: Optional Python object to associate with id. Stored only if
+                object tracking is enabled.
+
+        Returns:
+            The id used for this insert.
+
+        Raises:
+            ValueError: If the point is outside tree bounds.
+        """
+        if id is None:
+            id = self._next_id
+            self._next_id += 1
+        else:
+            # ensure future auto-ids do not collide
+            if id >= self._next_id:
+                self._next_id = id + 1
+
+        if not self._native.insert(id, xy):
+            x, y = xy
+            bx0, by0, bx1, by1 = self._bounds
+            raise ValueError(
+                f"Point ({x}, {y}) is outside bounds ({bx0}, {by0}, {bx1}, {by1})"
+            )
+
+        if self._items is not None:
+            self._items.add(Item(id, xy[0], xy[1], obj))
+
+        self._count += 1
+        return id
+
+    def insert_many_points(self, points: Iterable[Point]) -> int:
+        """
+        Bulk insert points with auto-assigned ids.
+
+        Args:
+            points: Iterable of (x, y) points.
+
+        Returns:
+            Number of points successfully inserted.
+
+        Raises:
+            ValueError: If any point is outside tree bounds.
+        """
+        ins = self._native.insert
+        nid = self._next_id
+        inserted = 0
+        bx0, by0, bx1, by1 = self._bounds
+        for xy in points:
+            id_ = nid
+            nid += 1
+            if not ins(id_, xy):
+                x, y = xy
+                raise ValueError(
+                    f"Point ({x}, {y}) is outside bounds ({bx0}, {by0}, {bx1}, {by1})"
+                )
+            inserted += 1
+            if self._items is not None:
+                self._items.add(Item(id_, xy[0], xy[1], None))
+        self._next_id = nid
+        self._count += inserted
+        return inserted
+
+    def attach(self, id: int, obj: Any) -> None:
+        """
+        Attach or replace the Python object for an existing id.
+        Tracking must be enabled.
+
+        Args:
+            id: Target id.
+            obj: Object to associate with id.
+        """
+        if self._items is None:
+            raise ValueError("Cannot attach objects when track_objects=False")
+
+        item = self._items.by_id(id)
+        if item is None:
+            raise KeyError(f"Id {id} not found in quadtree")
+        self._items.add(Item(id, item.x, item.y, obj))
+
+    def delete(self, id: int, xy: Point) -> bool:
+        """
+        Delete an item by id and exact coordinates.
+
+        Args:
+            id: Integer id to remove.
+            xy: Coordinates (x, y) of the item.
+
+        Returns:
+            True if the item was found and deleted, else False.
+        """
+        deleted = self._native.delete(id, xy)
+        if deleted:
+            self._count -= 1
+            if self._items is not None:
+                self._items.pop_id(id)  # ignore result
+        return deleted
+
+    def delete_by_object(self, obj: Any) -> bool:
+        """
+        Delete an item by Python object.
+
+        Requires object tracking to be enabled. Performs an O(1) reverse
+        lookup to get the id, then deletes that entry at the given location.
+
+        Args:
+            obj: The tracked Python object to remove.
+
+        Returns:
+            True if the item was found and deleted, else False.
+
+        Raises:
+            ValueError: If object tracking is disabled.
+        """
+        if self._items is None:
+            raise ValueError(
+                "Cannot delete by object when track_objects=False. Use delete(id, xy) instead."
+            )
+
+        item = self._items.by_obj(obj)
+        if item is None:
+            return False
+
+        return self.delete(item.id, (item.x, item.y))
+
+    # ---------- queries ----------
+
+    @overload
+    def query(
+        self, rect: Bounds, *, as_items: Literal[False] = ...
+    ) -> List[_IdCoord]: ...
+
+    @overload
+    def query(self, rect: Bounds, *, as_items: Literal[True]) -> List[Item]: ...
+
+    def query(
+        self, rect: Bounds, *, as_items: bool = False
+    ) -> List[_IdCoord] | List[Item]:
+        """
+        Return all points inside an axis-aligned rectangle.
+
+        Args:
+            rect: Query rectangle as (min_x, min_y, max_x, max_y).
+            as_items: If True, return Item wrappers. If False, return raw tuples.
+
+        Returns:
+            If as_items is False: list of (id, x, y) tuples.
+            If as_items is True: list of Item objects.
+        """
+        raw = self._native.query(rect)
+        if not as_items:
+            return raw
+
+        if self._items is None:
+            raise ValueError("Cannot return results as items with track_objects=False")
+        out: List[Item] = []
+        for id_, x, y in raw:
+            item = self._items.by_id(id_)
+            if item is None:
+                raise RuntimeError(
+                    f"Internal error: id {id_} found in native tree but missing from object tracker. "
+                    f"Ensure all inserts/deletes are done via this wrapper."
+                )
+            out.append(item)
+        return out
+
+    @overload
+    def nearest_neighbor(
+        self, xy: Point, *, as_item: Literal[False] = ...
+    ) -> Optional[_IdCoord]: ...
+
+    @overload
+    def nearest_neighbor(
+        self, xy: Point, *, as_item: Literal[True]
+    ) -> Optional[Item]: ...
+
+    def nearest_neighbor(self, xy: Point, *, as_item: bool = False):
+        """
+        Return the single nearest neighbor to the query point.
+
+        Args:
+            xy: Query point (x, y).
+            as_item: If True, return Item. If False, return (id, x, y).
+
+        Returns:
+            The nearest neighbor or None if the tree is empty.
+        """
+        t = self._native.nearest_neighbor(xy)
+        if t is None or not as_item:
+            return t
+
+        if self._items is None:
+            raise ValueError("Cannot return result as item with track_objects=False")
+        id_, x, y = t
+        item = self._items.by_id(id_)
+        if item is None:
+            raise RuntimeError(
+                f"Internal error: id {id_} found in native tree but missing from object tracker. "
+                f"Ensure all inserts/deletes are done via this wrapper."
+            )
+        return item
+
+    @overload
+    def nearest_neighbors(
+        self, xy: Point, k: int, *, as_items: Literal[False] = ...
+    ) -> List[_IdCoord]: ...
+
+    @overload
+    def nearest_neighbors(
+        self, xy: Point, k: int, *, as_items: Literal[True]
+    ) -> List[Item]: ...
+
+    def nearest_neighbors(self, xy: Point, k: int, *, as_items: bool = False):
+        """
+        Return the k nearest neighbors to the query point.
+
+        Args:
+            xy: Query point (x, y).
+            k: Number of neighbors to return.
+            as_items: If True, return Item wrappers. If False, return raw tuples.
+
+        Returns:
+            List of results in ascending distance order.
+        """
+        raw = self._native.nearest_neighbors(xy, k)
+        if not as_items:
+            return raw
+        if self._items is None:
+            raise ValueError("Cannot return results as items with track_objects=False")
+
+        out: List[Item] = []
+        for id_, _, _ in raw:
+            item = self._items.by_id(id_)
+            if item is None:
+                raise RuntimeError(
+                    f"Internal error: id {id_} found in native tree but missing from object tracker. "
+                    f"Ensure all inserts/deletes are done via this wrapper."
+                )
+            out.append(item)
+        return out
+
+    # ---------- misc ----------
+
+    def get(self, id: int) -> Any | None:
+        """
+        Return the object associated with id.
+
+        Returns:
+            The tracked object if present and tracking is enabled, else None.
+        """
+        if self._items is None:
+            raise ValueError("Cannot get objects when track_objects=False")
+        item = self._items.by_id(id)
+        if item is None:
+            return None
+        return item.obj
+
+    def get_all_rectangles(self) -> List[Bounds]:
+        """
+        Return all node rectangles in the current quadtree.
+
+        Returns:
+            List of (min_x, min_y, max_x, max_y) for each node in the tree.
+        """
+        return self._native.get_all_rectangles()
+
+    def get_all_objects(self) -> List[Any]:
+        """
+        Return all tracked objects.
+
+        Returns:
+            List of objects if tracking is enabled, else an empty list.
+        """
+        if self._items is None:
+            raise ValueError("Cannot get objects when track_objects=False")
+        return [t.obj for t in self._items.items() if t.obj is not None]
+
+    def get_all_items(self) -> List[Item]:
+        """
+        Return all tracked items.
+
+        Returns:
+            List of Item if tracking is enabled, else an empty list.
+        """
+        if self._items is None:
+            raise ValueError("Cannot get items when track_objects=False")
+        return list(self._items.items())
+
+    def count_items(self) -> int:
+        """
+        Return the number of items stored in the native tree.
+
+        Notes:
+            This calls the native engine and may differ from len(self) if
+            you create multiple wrappers around the same native structure.
+        """
+        return self._native.count_items()
+
+    def __len__(self) -> int:
+        """
+        Return the number of successful inserts done via this wrapper.
+
+        Notes:
+            This is the Python-side counter that tracks calls that returned True.
+            use count_items() to get the authoritative native-side count.
+        """
+        return self._count
+
+    # Power users can access the raw class
+    NativeQuadTree = _RustQuadTree
+
+
+__all__ = ["QuadTree", "Item", "Bounds", "Point"]

fastquadtree/__init__.pyi

@@ -0,0 +1,67 @@
+from typing import Any, Iterable, List, Optional, Tuple, Type, overload
+from typing import Literal as _Literal  # avoid polluting public namespace
+
+Bounds = Tuple[float, float, float, float]
+Point = Tuple[float, float]
+
+class Item:
+    id: int
+    x: float
+    y: float
+    obj: Any | None
+
+class QuadTree:
+    # Expose the raw native class for power users
+    NativeQuadTree: Type
+
+    def __init__(
+        self,
+        bounds: Bounds,
+        capacity: int,
+        *,
+        max_depth: Optional[int] = None,
+        track_objects: bool = False,
+        start_id: int = 1,
+    ) -> None: ...
+
+    # Inserts
+    def insert(self, xy: Point, *, id: Optional[int] = ..., obj: Any = ...) -> int: ...
+    def insert_many_points(self, points: Iterable[Point]) -> int: ...
+    def insert_many(self, items: Iterable[Tuple[Point, Any]]) -> int: ...
+    def attach(self, id: int, obj: Any) -> None: ...
+
+    # Deletions
+    def delete(self, id: int, xy: Point) -> bool: ...
+    def delete_by_object(self, obj: Any) -> bool: ...
+
+    # Queries
+    @overload
+    def query(
+        self, rect: Bounds, *, as_items: _Literal[False] = ...
+    ) -> List[Tuple[int, float, float]]: ...
+    @overload
+    def query(self, rect: Bounds, *, as_items: _Literal[True]) -> List[Item]: ...
+    @overload
+    def nearest_neighbor(
+        self, xy: Point, *, as_item: _Literal[False] = ...
+    ) -> Optional[Tuple[int, float, float]]: ...
+    @overload
+    def nearest_neighbor(
+        self, xy: Point, *, as_item: _Literal[True]
+    ) -> Optional[Item]: ...
+    @overload
+    def nearest_neighbors(
+        self, xy: Point, k: int, *, as_items: _Literal[False] = ...
+    ) -> List[Tuple[int, float, float]]: ...
+    @overload
+    def nearest_neighbors(
+        self, xy: Point, k: int, *, as_items: _Literal[True]
+    ) -> List[Item]: ...
+
+    # Misc
+    def get(self, id: int) -> Any | None: ...
+    def get_all_rectangles(self) -> List[Bounds]: ...
+    def get_all_objects(self) -> List[Any]: ...
+    def get_all_items(self) -> List[Item]: ...
+    def count_items(self) -> int: ...
+    def __len__(self) -> int: ...

fastquadtree/_bimap.py

@@ -0,0 +1,111 @@
+# _bimap.py
+from __future__ import annotations
+from typing import Any, Iterable, Iterator, Tuple, Optional
+
+from ._item import Item
+
+
+class BiMap:
+    """
+    Bidirectional map to the same Item:
+      id -> Item
+      obj -> Item  (uses object identity)
+
+    Rules:
+      - One-to-one: an id maps to exactly one Item, and an object maps to exactly one Item.
+      - add(item): inserts or replaces both sides so they point to 'item'.
+      - If item.obj is None, only id -> Item is stored.
+    """
+
+    __slots__ = ("_id_to_item", "_objid_to_item")
+
+    def __init__(self, items: Iterable[Item] | None = None) -> None:
+        self._id_to_item: dict[int, Item] = {}
+        self._objid_to_item: dict[int, Item] = {}
+        if items:
+            for it in items:
+                self.add(it)
+
+    # - core -
+
+    def add(self, item: Item) -> None:
+        """
+        Insert or replace mapping for this Item.
+        Handles conflicts so that both id and obj point to this exact Item.
+        """
+        id_ = item.id
+        obj = item.obj
+
+        # Unlink any old item currently bound to this id
+        old = self._id_to_item.get(id_)
+        if old is not None and old is not item:
+            old_obj = old.obj
+            if old_obj is not None:
+                self._objid_to_item.pop(id(old_obj), None)
+
+        # Unlink any old item currently bound to this obj
+        if obj is not None:
+            prev = self._objid_to_item.get(id(obj))
+            if prev is not None and prev is not item:
+                self._id_to_item.pop(prev.id, None)
+
+        # Link new
+        self._id_to_item[id_] = item
+        if obj is not None:
+            self._objid_to_item[id(obj)] = item
+
+    def by_id(self, id_: int) -> Optional[Item]:
+        return self._id_to_item.get(id_)
+
+    def by_obj(self, obj: Any) -> Optional[Item]:
+        return self._objid_to_item.get(id(obj))
+
+    def pop_id(self, id_: int) -> Optional[Item]:
+        it = self._id_to_item.pop(id_, None)
+        if it is not None:
+            obj = it.obj
+            if obj is not None:
+                self._objid_to_item.pop(id(obj), None)
+        return it
+
+    def pop_obj(self, obj: Any) -> Optional[Item]:
+        it = self._objid_to_item.pop(id(obj), None)
+        if it is not None:
+            self._id_to_item.pop(it.id, None)
+        return it
+
+    def pop_item(self, item: Item) -> Optional[Item]:
+        """
+        Remove this exact Item if present on either side.
+        """
+        removed = None
+        # Remove by id first
+        if self._id_to_item.get(item.id) is item:
+            removed = self._id_to_item.pop(item.id)
+        # Remove by obj side
+        obj = item.obj
+        if obj is not None and self._objid_to_item.get(id(obj)) is item:
+            self._objid_to_item.pop(id(obj), None)
+            removed = removed or item
+        return removed
+
+    # - convenience -
+
+    def __len__(self) -> int:
+        return len(self._id_to_item)
+
+    def clear(self) -> None:
+        self._id_to_item.clear()
+        self._objid_to_item.clear()
+
+    def contains_id(self, id_: int) -> bool:
+        return id_ in self._id_to_item
+
+    def contains_obj(self, obj: Any) -> bool:
+        return id(obj) in self._objid_to_item
+
+    def items_by_id(self) -> Iterator[Tuple[int, Item]]:
+        return iter(self._id_to_item.items())
+
+    def items(self) -> Iterator[Item]:
+        return iter(self._id_to_item.values())

fastquadtree/_item.py

@@ -0,0 +1,23 @@
+# item.py
+from __future__ import annotations
+from typing import Any
+
+
+class Item:
+    """
+    Lightweight view of an index entry.
+
+    Attributes:
+        id: Integer identifier.
+        x: X coordinate.
+        y: Y coordinate.
+        obj: The attached Python object if available, else None.
+    """
+
+    __slots__ = ("id", "x", "y", "obj")
+
+    def __init__(self, id: int, x: float, y: float, obj: Any | None = None):
+        self.id = id
+        self.x = x
+        self.y = y
+        self.obj = obj

fastquadtree-0.4.0.dist-info/METADATA

@@ -0,0 +1,288 @@
+Metadata-Version: 2.4
+Name: fastquadtree
+Version: 0.4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Classifier: License :: OSI Approved :: MIT License
+License-File: LICENSE
+Summary: Rust-accelerated quadtree for Python with fast inserts, range queries, and k-NN search.
+Keywords: quadtree,spatial-index,geometry,rust,pyo3,nearest-neighbor,k-nn
+Author: Ethan Anderson
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Project-URL: Homepage, https://github.com/Elan456/fastquadtree
+Project-URL: Repository, https://github.com/Elan456/fastquadtree
+Project-URL: Issues, https://github.com/Elan456/fastquadtree/issues
+
+# fastquadtree
+
+[![PyPI Downloads](https://static.pepy.tech/personalized-badge/fastquadtree?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=BLUE&left_text=downloads)](https://pepy.tech/projects/fastquadtree)
+
+![Interactive_V2_Screenshot](https://raw.githubusercontent.com/Elan456/fastquadtree/main/assets/interactive_v2_screenshot.png)
+
+
+Rust-optimized quadtree with a simple Python API.
+
+- Python package: **`fastquadtree`**
+- Python ≥ 3.8
+- Import path: `from fastquadtree import QuadTree`
+
+## Install
+
+```bash
+pip install fastquadtree
+````
+
+If you are developing locally:
+
+```bash
+# optimized dev install
+maturin develop --release
+```
+
+## Quickstart
+
+```python
+from fastquadtree import QuadTree
+
+# Bounds are (min_x, min_y, max_x, max_y)
+qt = QuadTree(bounds=(0, 0, 1000, 1000), capacity=20)  # max_depth is optional
+
+# Insert points with auto ids
+id1 = qt.insert((10, 10))
+id2 = qt.insert((200, 300))
+id3 = qt.insert((999, 500), id=42)  # you can supply your own id
+
+# Axis-aligned rectangle query
+hits = qt.query((0, 0, 250, 350))  # returns [(id, x, y), ...] by default
+print(hits)  # e.g. [(1, 10.0, 10.0), (2, 200.0, 300.0)]
+
+# Nearest neighbor
+best = qt.nearest_neighbor((210, 310))  # -> (id, x, y) or None
+print(best)
+
+# k-nearest neighbors
+top3 = qt.nearest_neighbors((210, 310), 3)
+print(top3)  # list of up to 3 (id, x, y) tuples
+
+# Delete items by ID and location
+deleted = qt.delete(id2, (200, 300))  # True if found and deleted
+print(f"Deleted: {deleted}")
+print(f"Remaining items: {qt.count_items()}")
+
+# For object tracking with track_objects=True
+qt_tracked = QuadTree((0, 0, 1000, 1000), capacity=4, track_objects=True)
+player1 = {"name": "Alice", "score": 100}
+player2 = {"name": "Bob", "score": 200}
+
+id1 = qt_tracked.insert((50, 50), obj=player1)
+id2 = qt_tracked.insert((150, 150), obj=player2)
+
+# Delete by object reference (O(1) lookup!)
+deleted = qt_tracked.delete_by_object(player1, (50, 50))
+print(f"Deleted player: {deleted}")  # True
+```
+
+### Working with Python objects
+
+You can keep the tree pure and manage your own id → object map, or let the wrapper manage it.
+
+**Option A: Manage your own map**
+
+```python
+from fastquadtree import QuadTree
+
+qt = QuadTree((0, 0, 1000, 1000), capacity=16)
+objects: dict[int, object] = {}
+
+def add(obj) -> int:
+    obj_id = qt.insert(obj.position)  # auto id
+    objects[obj_id] = obj
+    return obj_id
+
+# Later, resolve ids back to objects
+ids = [obj_id for (obj_id, x, y) in qt.query((100, 100, 300, 300))]
+selected = [objects[i] for i in ids]
+```
+
+**Option B: Ask the wrapper to track objects**
+
+```python
+from fastquadtree import QuadTree
+
+qt = QuadTree((0, 0, 1000, 1000), capacity=16, track_objects=True)
+
+# Store the object alongside the point
+qt.insert((25, 40), obj={"name": "apple"})
+
+# Ask for Item objects so you can access .obj lazily
+items = qt.query((0, 0, 100, 100), as_items=True)
+for it in items:
+    print(it.id, it.x, it.y, it.obj)
+```
+
+You can also attach or replace an object later:
+
+```python
+qt.attach(123, my_object)  # binds object to id 123
+```
+
+## API
+
+### `QuadTree(bounds, capacity, *, max_depth=None, track_objects=False, start_id=1)`
+
+* `bounds` — tuple `(min_x, min_y, max_x, max_y)` defines the 2D area covered by the quadtree
+* `capacity` — max number of points kept in a leaf before splitting
+* `max_depth` — optional depth cap. If omitted, the tree can keep splitting as needed
+* `track_objects` — if `True`, the wrapper maintains an id → object map for convenience.
+* `start_id` — starting value for auto-assigned ids
+
+### Core Methods
+
+Full docs are in the docstrings of the [Python Shim](pysrc/fastquadtree/__init__.py)
+
+- `insert(xy, *, id=None, obj=None) -> int`
+
+- `insert_many_points(points) -> int`
+
+- `query(rect, *, as_items=False) -> list`
+
+- `nearest_neighbor(xy, *, as_item=False) -> (id, x, y) | Item | None`
+
+- `nearest_neighbors(xy, k, *, as_items=False) -> list`
+
+- `delete(id, xy) -> bool`
+
+- `delete_by_object(obj) -> bool (requires track_objects=True)`
+
+- `attach(id, obj) -> None (requires track_objects=True)`
+
+- `count_items() -> int`
+
+- `get(id) -> object | None`
+
+- `get_all_rectangles() -> list[tuple] (for visualization)`
+
+### `Item` (returned when `as_items=True`)
+
+* Attributes: `id`, `x`, `y`, and a lazy `obj` property
+* Accessing `obj` performs a dictionary lookup only if tracking is enabled
+
+### Geometric conventions
+
+* Rectangles are `(min_x, min_y, max_x, max_y)`.
+* Containment rule is closed on the min edge and open on the max edge
+  `(x >= min_x and x < max_x and y >= min_y and y < max_y)`.
+  This only matters for points exactly on edges.
+
+## Performance tips
+
+* Choose `capacity` so that leaves keep a small batch of points. Typical values are 8 to 64.
+* If your data is very skewed, set a `max_depth` to prevent long chains.
+* For fastest local runs, use `maturin develop --release`.
+* The wrapper keeps Python overhead low: raw tuple results by default, `Item` wrappers only when requested.
+
+## Benchmarks
+
+fastquadtree outperforms all other quadtree python packages (at least all the ones I could find and install via pip.)
+
+### Library comparison
+
+![Total time](https://raw.githubusercontent.com/Elan456/fastquadtree/main/assets/quadtree_bench_time.png)
+![Throughput](https://raw.githubusercontent.com/Elan456/fastquadtree/main/assets/quadtree_bench_throughput.png)
+
+### Summary (largest dataset, PyQtree baseline)
+- Points: **500,000**, Queries: **500**
+- Fastest total: **fastquadtree** at **2.207 s**
+
+| Library | Build (s) | Query (s) | Total (s) | Speed vs PyQtree |
+|---|---:|---:|---:|---:|
+| fastquadtree  | 0.321 | 1.885 | 2.207 | 4.27× |
+| Rtree        | 1.718 | 4.376 | 6.095 | 1.55× |
+| nontree-QuadTree | 1.617 | 7.643 | 9.260 | 1.02× |
+| PyQtree      | 4.349 | 5.082 | 9.431 | 1.00× |
+| quads        | 3.874 | 9.058 | 12.932 | 0.73× |
+| e-pyquadtree | 2.732 | 10.598 | 13.330 | 0.71× |
+| Brute force  | 0.019 | 19.986 | 20.005 | 0.47× |
+
+### Native vs Shim
+
+**Setup**
+- Points: 500,000
+- Queries: 500
+- Repeats: 5
+
+**Timing (seconds)**
+
+| Variant | Build | Query | Total |
+|---|---:|---:|---:|
+| Native | 0.483 | 4.380 | 4.863 |
+| Shim (no map) | 0.668 | 4.167 | 4.835 |
+| Shim (track+objs) | 1.153 | 4.458 | 5.610 |
+
+**Overhead vs Native**
+
+- No map: build 1.38x, query 0.95x, total 0.99x  
+- Track + objs: build 2.39x, query 1.02x, total 1.15x
+
+### Run benchmarks
+To run the benchmarks yourself, first install the dependencies:
+
+```bash
+pip install -r benchmarks/requirements.txt
+```
+
+Then run:
+
+```bash
+python benchmarks/cross_library_bench.py
+python benchmarks/benchmark_native_vs_shim.py 
+```
+
+## Run Visualizer
+A visualizer is included to help you understand how the quadtree subdivides space.
+
+```bash
+pip install -r interactive/requirements.txt
+python interactive/interactive_v2.py
+```
+
+Check the CLI arguments for the cross-library benchmark in `benchmarks/quadtree_bench/main.py`.
+
+## FAQ
+
+**What happens if I insert the same id more than once?**
+Allowed. For k-nearest, duplicates are de-duplicated by id. For range queries you will see every inserted point.
+
+**Can I delete items from the quadtree?**
+Yes! Use `delete(id, xy)` to remove specific items. You must provide both the ID and exact location for precise deletion. This handles cases where multiple items exist at the same location. If you're using `track_objects=True`, you can also use `delete_by_object(obj, xy)` for convenient object-based deletion with O(1) lookup. The tree automatically merges nodes when item counts drop below capacity.
+
+**Can I store rectangles or circles?**
+The core stores points. To index objects with extent, insert whatever representative point you choose. For rectangles you can insert centers or build an AABB tree separately.
+
+**Threading**
+Use one tree per thread if you need heavy parallel inserts from Python.
+
+## License
+
+MIT. See `LICENSE`.
+
+## Acknowledgments
+
+* Python libraries compared: [PyQtree], [e-pyquadtree], [Rtree], [nontree], [quads]
+* Built with [PyO3] and [maturin]
+
+[PyQtree]: https://pypi.org/project/pyqtree/
+[e-pyquadtree]: https://pypi.org/project/e-pyquadtree/
+[PyO3]: https://pyo3.rs/
+[maturin]: https://www.maturin.rs/
+[Rtree]: https://pypi.org/project/Rtree/
+[nontree]: https://pypi.org/project/nontree/
+[quads]: https://pypi.org/project/quads/

fastquadtree-0.4.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+fastquadtree-0.4.0.dist-info/METADATA,sha256=3t-XheiR-GXWFVWY0zHsbmZCqmxP9RgzQ2a8MHh4gD8,9331
+fastquadtree-0.4.0.dist-info/WHEEL,sha256=2A3mFKbbStZmBBWlvTTYUEM089PovEhjpJwyy5qmAeE,146
+fastquadtree-0.4.0.dist-info/licenses/LICENSE,sha256=pRuvcuqIMtEUBMgvP1Bc4fOHydzeuA61c6DQoQ1pb1w,1071
+fastquadtree/__init__.py,sha256=fAHXmWTWeZFEPE2WSWhL1Hyt0QCaCZt84AXNdyLWwY0,12264
+fastquadtree/__init__.pyi,sha256=rNR03KUZxjWKz0ZezzatYHdhQX85EBFOAVH-qoHKhws,2099
+fastquadtree/_bimap.py,sha256=xQ1Y91sWQcI0OL_uNwEP41WLKVlDqKYmYI3Vnj_Jdss,3415
+fastquadtree/_item.py,sha256=Sk3oFVOOx0o83mJVHhAaN7WJzAvIy3SEGPtOeOYiCWo,503
+fastquadtree/_native.abi3.so,sha256=BTXQEO5qaMpi5Zj44tN1WOOICLjXOXshggZbGkP4tso,915328
+fastquadtree/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fastquadtree-0.4.0.dist-info/RECORD,,

fastquadtree-0.4.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.9.4)
+Root-Is-Purelib: false
+Tag: cp38-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2

fastquadtree-0.4.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ethan Anderson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.