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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastquadtree
-Version: 0.6.1
+Version: 0.8.0
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Rust
@@ -12,11 +12,18 @@ Classifier: Topic :: Software Development :: Libraries
 Classifier: Typing :: Typed
 Classifier: License :: OSI Approved :: MIT License
 Requires-Dist: ruff>=0.6.0 ; extra == 'dev'
-Requires-Dist: pytest>=7.0 ; extra == 'dev'
-Requires-Dist: pytest-cov>=4.1 ; extra == 'dev'
+Requires-Dist: pytest>=8.4.2 ; extra == 'dev'
+Requires-Dist: pytest-cov>=7.0.0 ; 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'
+Requires-Dist: maturin>=1.5 ; 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 +33,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)
@@ -37,7 +46,7 @@ Project-URL: Issues, https://github.com/Elan456/fastquadtree/issues
 
 [![PyPI Downloads](https://static.pepy.tech/personalized-badge/fastquadtree?period=total&units=INTERNATIONAL_SYSTEM&left_color=GRAY&right_color=BLUE&left_text=Total+Downloads)](https://pepy.tech/projects/fastquadtree)
 
-[![Build](https://github.com/Elan456/fastquadtree/actions/workflows/release.yml/badge.svg)](https://github.com/Elan456/fastquadtree/actions/workflows/ci.yml)
+[![Build](https://github.com/Elan456/fastquadtree/actions/workflows/release.yml/badge.svg)](https://github.com/Elan456/fastquadtree/actions/workflows/release.yml)
 [![Codecov](https://codecov.io/gh/Elan456/fastquadtree/branch/main/graph/badge.svg)](https://codecov.io/gh/Elan456/fastquadtree)
 
 [![Rust core via PyO3](https://img.shields.io/badge/Rust-core%20via%20PyO3-orange)](https://pyo3.rs/)
@@ -51,6 +60,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`
@@ -66,7 +77,6 @@ fastquadtree **outperforms** all other quadtree Python packages, including the R
 
 ### Summary (largest dataset, PyQtree baseline)
 - Points: **250,000**, Queries: **500**
---------------------
 - Fastest total: **fastquadtree** at **0.120 s**
 
 | Library | Build (s) | Query (s) | Total (s) | Speed vs PyQtree |
@@ -79,7 +89,7 @@ fastquadtree **outperforms** all other quadtree Python packages, including the R
 | PyQtree      | 1.492 | 0.263 | 1.755 | 1.00× |
 | quads        | 1.407 | 0.484 | 1.890 | 0.93× |
 
-#### Benchmark Configuration
+### Benchmark Configuration
 | Parameter | Value |
 |---|---:|
 | Bounds | (0, 0, 1000, 1000) |
@@ -87,11 +97,13 @@ fastquadtree **outperforms** all other quadtree Python packages, including the R
 | Max depth | 16 |
 | Queries per experiment | 500 |
 
+See the [benchmark section](https://elan456.github.io/fastquadtree/benchmark/) for details.
+
 ## Install
 
 ```bash
 pip install fastquadtree
-````
+```
 
 If you are developing locally:
 
@@ -101,76 +113,12 @@ 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)
-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.
-
-**Wrapper Managed 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 within a bounding box
-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
-```
+[See the quickstart guide](https://elan456.github.io/fastquadtree/quickstart/)
 
 ## API
 
+[See the full API](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
@@ -179,36 +127,17 @@ qt.attach(123, my_object)  # binds object to id 123
 * `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)
+### Key Methods
 
 - `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
+There are more methods and object tracking versions in the [docs](https://elan456.github.io/fastquadtree/api/quadtree/).
 
 ### Geometric conventions
 
@@ -222,52 +151,17 @@ 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.
-
-
-### Native vs Shim Benchmark
-
-**Setup**
-- Points: 500,000
-- Queries: 500
-- Repeats: 5
-
-**Timing (seconds)**
+* The wrapper maintains an object map only if the quadtree was constructed with `track_objects=True`. If you don't need it, leave it off for best performance.
+* Refer to the [Native vs Shim Benchmark](https://elan456.github.io/fastquadtree/benchmark/#native-vs-shim-benchmark) for overhead details.
 
-| 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 |
+### Pygame Ball Pit Demo
 
-**Overhead vs Native**
+![Ballpit_Demo_Screenshot](https://raw.githubusercontent.com/Elan456/fastquadtree/main/assets/ballpit.png)
 
-- No map: build 1.38x, query 0.95x, total 0.99x  
-- Track + objs: build 2.39x, query 1.02x, total 1.15x
+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.
 
-### 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`.
+See the [runnables guide](https://elan456.github.io/fastquadtree/runnables/) for setup instructions.
 
 ## FAQ
 
@@ -278,10 +172,7 @@ Allowed. For k-nearest, duplicates are de-duplicated by id. For range queries yo
 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)` 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.
+Yes, you can store rectangles using the `RectQuadTree` class. Circles can be approximated with bounding boxes. See the [RectQuadTree docs](https://elan456.github.io/fastquadtree/api/rect_quadtree/) for details.
 
 ## License
 

fastquadtree-0.8.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+fastquadtree-0.8.0.dist-info/METADATA,sha256=CK8OPp9c36mESYvCPafheE8Rdt9oVbtuJOoDJjvXiRw,8632
+fastquadtree-0.8.0.dist-info/WHEEL,sha256=CG8OzNtm0LMpJ2zhrjswlO8N-965OeMLklsQAG-nMvQ,94
+fastquadtree-0.8.0.dist-info/licenses/LICENSE,sha256=46IVFhoCIwMo-ocq4olyEB1eBvvtaKic5yGLeKXnDuc,1092
+fastquadtree/__init__.py,sha256=jy7uimnd7QDllmNOgnRByKom1aONIKOWhCvCJxndsnM,200
+fastquadtree/_base_quadtree.py,sha256=sfHAvKsWbrBX6RSUNi32Lh0fxCu8D6hAnyp1-SJj0Ok,8676
+fastquadtree/_bimap.py,sha256=oNvJOk-BjYLo6aNJnG0i3uEQCq8FsUTGRE6c6_kVC2c,3439
+fastquadtree/_item.py,sha256=cXiKXCjCfOWK19LUbxnzvAx6xffejd3F1axxYR9SMeM,1400
+fastquadtree/_native.pyd,sha256=wr7KjDtXszGOlm8GvAkKjeZugzOq_o23lbqV-D8_6Ko,271360
+fastquadtree/point_quadtree.py,sha256=Xs2Igat4ekewnMd2wHVYu0pm7f7duvLdEcm_DUrO2B4,5744
+fastquadtree/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fastquadtree/rect_quadtree.py,sha256=_t3RVZYSSxZatGCtv4G9Cokn6mJ8BMDsmWHAo7fsAaE,3569
+fastquadtree-0.8.0.dist-info/RECORD,,

{fastquadtree-0.6.1.dist-info → fastquadtree-0.8.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/__init__.pyi

@@ -1,70 +0,0 @@
-from typing import (
-    Any,
-    Iterable,
-    Literal as _Literal,  # avoid polluting public namespace
-    overload,
-)
-
-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: int | None = None,
-        track_objects: bool = False,
-        start_id: int = 1,
-    ) -> None: ...
-
-    # Inserts
-    def insert(self, xy: Point, *, id_: int | None = ..., obj: Any = ...) -> int: ...
-    def insert_many_points(self, points: Iterable[Point]) -> 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] = ...
-    ) -> tuple[int, float, float] | None: ...
-    @overload
-    def nearest_neighbor(
-        self, xy: Point, *, as_item: _Literal[True]
-    ) -> Item | None: ...
-    @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-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,,