fastquadtree 0.6.1__cp38-abi3-win_amd64.whl → 0.7.0__cp38-abi3-win_amd64.whl

fastquadtree/__init__.py

@@ -45,7 +45,15 @@ class QuadTree:
         ValueError: If parameters are invalid or inserts are out of bounds.
     """
 
-    __slots__ = ("_bounds", "_count", "_items", "_native", "_next_id")
+    __slots__ = (
+        "_bounds",
+        "_capacity",
+        "_count",
+        "_items",
+        "_max_depth",
+        "_native",
+        "_next_id",
+    )
 
     def __init__(
         self,
@@ -56,14 +64,18 @@ class QuadTree:
         track_objects: bool = False,
         start_id: int = 1,
     ):
+        self._bounds = bounds
+        self._max_depth = max_depth  # store for clear()
+        self._capacity = capacity  # store for clear()
         if max_depth is None:
-            self._native = _RustQuadTree(bounds, capacity)
+            self._native = _RustQuadTree(self._bounds, self._capacity)
         else:
-            self._native = _RustQuadTree(bounds, capacity, max_depth=max_depth)
+            self._native = _RustQuadTree(
+                self._bounds, self._capacity, max_depth=max_depth
+            )
         self._items: BiMap | None = BiMap() if track_objects else None
         self._next_id: int = int(start_id)
         self._count: int = 0
-        self._bounds = bounds
 
     # ---------- inserts ----------
 
@@ -148,6 +160,8 @@ class QuadTree:
             raise KeyError(f"Id {id_} not found in quadtree")
         self._items.add(Item(id_, item.x, item.y, obj))
 
+    # ---------- deletes ----------
+
     def delete(self, id_: int, xy: Point) -> bool:
         """
         Delete an item by id and exact coordinates.
@@ -193,6 +207,28 @@ class QuadTree:
 
         return self.delete(item.id_, (item.x, item.y))
 
+    def clear(self, *, reset_ids: bool = False) -> None:
+        """
+        Empty the tree in place, preserving bounds/capacity/max_depth.
+
+        Args:
+            reset_ids: If True, restart auto-assigned ids from 1.
+        """
+        # swap in a fresh native instance
+        if self._max_depth is None:
+            self._native = _RustQuadTree(self._bounds, self._capacity)
+        else:
+            self._native = _RustQuadTree(
+                self._bounds, self._capacity, max_depth=self._max_depth
+            )
+
+        # reset Python-side trackers
+        self._count = 0
+        if self._items is not None:
+            self._items.clear()
+        if reset_ids:
+            self._next_id = 1
+
     # ---------- queries ----------
 
     @overload

fastquadtree/__init__.pyi

@@ -36,6 +36,7 @@ class QuadTree:
     # Deletions
     def delete(self, id_: int, xy: Point) -> bool: ...
     def delete_by_object(self, obj: Any) -> bool: ...
+    def clear(self, *, reset_ids: bool = False) -> None: ...
 
     # Queries
     @overload

{fastquadtree-0.6.1.dist-info → fastquadtree-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastquadtree
-Version: 0.6.1
+Version: 0.7.0
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Rust
@@ -17,6 +17,12 @@ Requires-Dist: pytest-cov>=4.1 ; extra == 'dev'
 Requires-Dist: coverage>=7.5 ; extra == 'dev'
 Requires-Dist: mypy>=1.10 ; extra == 'dev'
 Requires-Dist: build>=1.2.1 ; extra == 'dev'
+Requires-Dist: mkdocs>=1.6 ; extra == 'dev'
+Requires-Dist: mkdocs-material ; extra == 'dev'
+Requires-Dist: mkdocstrings[python] ; extra == 'dev'
+Requires-Dist: mkdocs-autorefs ; extra == 'dev'
+Requires-Dist: mkdocs-git-revision-date-localized-plugin ; extra == 'dev'
+Requires-Dist: mkdocs-minify-plugin ; extra == 'dev'
 Provides-Extra: dev
 License-File: LICENSE
 Summary: Rust-accelerated quadtree for Python with fast inserts, range queries, and k-NN search.
@@ -26,10 +32,12 @@ 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: Documentation, https://elan456.github.io/fastquadtree/
 Project-URL: Issues, https://github.com/Elan456/fastquadtree/issues
 
 # fastquadtree
 
+[![Docs](https://img.shields.io/badge/docs-online-brightgreen)](https://elan456.github.io/fastquadtree/)
 [![PyPI version](https://img.shields.io/pypi/v/fastquadtree.svg)](https://pypi.org/project/fastquadtree/)
 [![Python versions](https://img.shields.io/pypi/pyversions/fastquadtree.svg)](https://pypi.org/project/fastquadtree/)
 [![Wheels](https://img.shields.io/pypi/wheel/fastquadtree.svg)](https://pypi.org/project/fastquadtree/#files)
@@ -51,6 +59,8 @@ Project-URL: Issues, https://github.com/Elan456/fastquadtree/issues
 
 Rust-optimized quadtree with a simple Python API.
 
+👉 **Docs:** https://elan456.github.io/fastquadtree/
+
 - Python package: **`fastquadtree`**
 - Python ≥ 3.8
 - Import path: `from fastquadtree import QuadTree`
@@ -171,6 +181,8 @@ qt.attach(123, my_object)  # binds object to id 123
 
 ## API
 
+[Full api for QuadTree](https://elan456.github.io/fastquadtree/api/quadtree/)
+
 ### `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
@@ -181,8 +193,6 @@ qt.attach(123, my_object)  # binds object to id 123
 
 ### 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`
@@ -197,6 +207,8 @@ Full docs are in the docstrings of the [Python Shim](pysrc/fastquadtree/__init__
 
 - `delete_by_object(obj) -> bool (requires track_objects=True)`
 
+- `clear(*, reset_ids=False) -> None`
+
 - `attach(id, obj) -> None (requires track_objects=True)`
 
 - `count_items() -> int`
@@ -205,6 +217,8 @@ Full docs are in the docstrings of the [Python Shim](pysrc/fastquadtree/__init__
 
 - `get_all_rectangles() -> list[tuple] (for visualization)`
 
+- `get_all_objects() -> list[object] (requires track_objects=True)`
+
 ### `Item` (returned when `as_items=True`)
 
 * Attributes: `id`, `x`, `y`, and a lazy `obj` property
@@ -222,7 +236,7 @@ Full docs are in the docstrings of the [Python Shim](pysrc/fastquadtree/__init__
 * 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.
+* The wrapper only maintains an ID -> Obj map only if the quadtree was constructed with `track_objects=True`. If you don't need it, leave it off for best performance. Look at the [Native vs Shim Benchmark](#native-vs-shim-benchmark) below for details.
 
 
 ### Native vs Shim Benchmark
@@ -259,6 +273,8 @@ python benchmarks/cross_library_bench.py
 python benchmarks/benchmark_native_vs_shim.py 
 ```
 
+Check the CLI arguments for the cross-library benchmark in `benchmarks/quadtree_bench/main.py`.
+
 ## Run Visualizer
 A visualizer is included to help you understand how the quadtree subdivides space.
 
@@ -267,7 +283,17 @@ 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`.
+### Pygame Ball Pit Demo
+
+![Ballpit_Demo_Screenshot](https://raw.githubusercontent.com/Elan456/fastquadtree/main/assets/ballpit.png)
+
+A simple demo of moving objects with collision detection using **fastquadtree**. 
+You can toggle between quadtree mode and brute-force mode to see the performance difference.
+
+```bash
+pip install -r interactive/requirements.txt
+python interactive/ball_pit.py
+```
 
 ## FAQ
 
@@ -280,9 +306,6 @@ Yes! Use `delete(id, xy)` to remove specific items. You must provide both the ID
 **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`.

fastquadtree-0.7.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+fastquadtree-0.7.0.dist-info/METADATA,sha256=19O4oecQfX8PIgl0uy9SpM9vc3clkiHWYHyaKYJ8UEM,11867
+fastquadtree-0.7.0.dist-info/WHEEL,sha256=CG8OzNtm0LMpJ2zhrjswlO8N-965OeMLklsQAG-nMvQ,94
+fastquadtree-0.7.0.dist-info/licenses/LICENSE,sha256=46IVFhoCIwMo-ocq4olyEB1eBvvtaKic5yGLeKXnDuc,1092
+fastquadtree/__init__.py,sha256=ACXdXobZxuh1tNM2HfXyl_bLS5s8zXgD29AUiVvba44,13471
+fastquadtree/__init__.pyi,sha256=ngFGDYWTB7AdR0k9ujstsGPnQh9wU0H0_GPiNm7HDhY,2124
+fastquadtree/_bimap.py,sha256=SPFFw9hWAVRKZVXyDGYFFNw4MLV8qUlOq8gDbLcTqkg,3402
+fastquadtree/_item.py,sha256=p-ymnE9S-c8Lc00KhNKN9Pt4bd05nZ6g-DB8q8D9zYk,533
+fastquadtree/_native.pyd,sha256=k7Wlr44ED8FZY-rCRp7SzrThf6BooXWxMvkxBTfrDA4,254464
+fastquadtree/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fastquadtree-0.7.0.dist-info/RECORD,,

{fastquadtree-0.6.1.dist-info → fastquadtree-0.7.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (1.9.5)
+Generator: maturin (1.9.6)
 Root-Is-Purelib: false
 Tag: cp38-abi3-win_amd64

fastquadtree-0.6.1.dist-info/RECORD

@@ -1,10 +0,0 @@
-fastquadtree-0.6.1.dist-info/METADATA,sha256=H8lkeuXlgH2BCxZSzEvFAKnLANM4H52NG78hT7AObUk,10746
-fastquadtree-0.6.1.dist-info/WHEEL,sha256=F7HFsRl56IeLjGhxiHeG3IpurHNaGNHQJeIy7gdwTO4,94
-fastquadtree-0.6.1.dist-info/licenses/LICENSE,sha256=46IVFhoCIwMo-ocq4olyEB1eBvvtaKic5yGLeKXnDuc,1092
-fastquadtree/__init__.py,sha256=o7zH6lOu2lTxMafl9FNVZiecM0KVxqhC3FNSRbpaaqY,12435
-fastquadtree/__init__.pyi,sha256=_HGJ9lpIZ9-JTSfMKSn8aif_tu60m2vgOXR4d0uXnRY,2062
-fastquadtree/_bimap.py,sha256=SPFFw9hWAVRKZVXyDGYFFNw4MLV8qUlOq8gDbLcTqkg,3402
-fastquadtree/_item.py,sha256=p-ymnE9S-c8Lc00KhNKN9Pt4bd05nZ6g-DB8q8D9zYk,533
-fastquadtree/_native.pyd,sha256=OHlc3FG-kZbjt2YW2QM9I809C1FRQlV6RQXcPcQLNhM,254464
-fastquadtree/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fastquadtree-0.6.1.dist-info/RECORD,,