rstar-python 0.1.0__cp310-abi3-win_amd64.whl

rstar_python/__init__.py

@@ -0,0 +1,3 @@
+from .rstar_python import PyRTree, __version__
+
+__all__ = ["PyRTree", "__version__"]

rstar_python/rstar_python.pyi

@@ -0,0 +1,77 @@
+from typing import Sequence
+
+import numpy as np
+import numpy.typing as npt
+
+__version__: str
+
+class PyRTree:
+    """An R*-tree spatial index over points of 2 to 8 dimensions.
+
+    Each point carries an integer id (auto-assigned or supplied via ``data``).
+    Coordinate-returning queries return coordinates; the vectorised
+    ``query``/``query_radius`` return the stored ids.
+    """
+
+    def __init__(self, dims: int) -> None: ...
+    @property
+    def dims(self) -> int:
+        """Number of dimensions this tree indexes."""
+
+    def insert(self, point: Sequence[float], data: int | None = ...) -> int:
+        """Insert a single point, returning its id.
+
+        If ``data`` is omitted, an incrementing id is assigned automatically.
+        """
+
+    def bulk_load(
+        self,
+        points: Sequence[Sequence[float]] | npt.NDArray[np.float64],
+        data: Sequence[int] | None = ...,
+    ) -> None:
+        """Build the tree from many points at once (replaces existing contents).
+
+        ``data`` optionally supplies one id per point; otherwise ids are ``0..n``.
+        """
+
+    def nearest_neighbor(self, point: Sequence[float]) -> list[float] | None:
+        """Coordinates of the single nearest point, or ``None`` if empty."""
+
+    def k_nearest_neighbors(
+        self, point: Sequence[float], k: int
+    ) -> list[list[float]]:
+        """Coordinates of the ``k`` nearest points, closest first."""
+
+    def neighbors_within_radius(
+        self, point: Sequence[float], radius: float
+    ) -> list[list[float]]:
+        """Coordinates of all points within ``radius`` (Euclidean)."""
+
+    def locate_in_envelope(
+        self, min_corner: Sequence[float], max_corner: Sequence[float]
+    ) -> list[list[float]]:
+        """Coordinates of all points inside the axis-aligned box."""
+
+    def query(
+        self, points: npt.NDArray[np.float64], k: int = ...
+    ) -> tuple[npt.NDArray[np.float64], npt.NDArray[np.int64]]:
+        """Vectorised k-NN query (scipy/sklearn style).
+
+        ``points`` is an ``(M, dims)`` array. Returns ``(distances, ids)`` of
+        ``(M, k)`` arrays. Slots beyond the available points are ``inf`` / ``-1``.
+        """
+
+    def query_radius(
+        self, points: npt.NDArray[np.float64], radius: float
+    ) -> list[list[int]]:
+        """Vectorised radius query: per query point, the ids within ``radius``."""
+
+    def remove(self, point: Sequence[float]) -> bool:
+        """Remove a point by coordinates. Returns ``True`` if one was removed."""
+
+    def size(self) -> int:
+        """Number of points in the tree."""
+
+    def __len__(self) -> int: ...
+    def __contains__(self, point: Sequence[float]) -> bool: ...
+    def __repr__(self) -> str: ...

rstar_python-0.1.0.dist-info/METADATA

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: rstar-python
+Version: 0.1.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Requires-Dist: numpy>=1.21.6
+License-File: LICENSE
+Summary: Python bindings for the rstar R*-tree spatial index
+Home-Page: https://github.com/kephale/rstar-python
+Author-email: Kyle Harrington <kyle@kyleharrington.com>
+License: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/kephale/rstar-python
+Project-URL: Issues, https://github.com/kephale/rstar-python/issues
+Project-URL: Repository, https://github.com/kephale/rstar-python
+
+# rstar-python
+
+Python bindings for the [rstar](https://github.com/georust/rstar) R*-tree spatial index library.
+
+A fast, **dynamic** spatial index for points in 2–8 dimensions: insert and remove
+points after construction, run nearest-neighbour and radius searches, and query
+axis-aligned bounding boxes. Each point can carry an integer id so queries can
+return references to *your* data, not just coordinates.
+
+## Installation
+
+```bash
+pip install rstar-python
+```
+
+Prebuilt `abi3` wheels are published for Linux, macOS, and Windows and work on
+CPython 3.10+.
+
+## Why rstar-python?
+
+|                              | rstar-python | scipy `cKDTree` / sklearn `KDTree` | `Rtree` (libspatialindex) |
+| ---------------------------- | :----------: | :--------------------------------: | :-----------------------: |
+| Dynamic insert / remove      |      ✅       |        ❌ (static, rebuild)         |             ✅             |
+| Bounding-box / region query  |      ✅       |          ❌ (radius only)           |             ✅             |
+| Returns ids of matches       |      ✅       |          ✅ (row indices)           |             ✅             |
+| Vectorised batch query       |      ✅       |                 ✅                  |             ❌             |
+| Pure-Rust, no system C/C++ dep |    ✅       |       (C/Cython, bundled)          |   ❌ (needs libspatialindex) |
+
+Reach for the KD-trees in scipy/scikit-learn when you build an index *once* from
+a static array and only need point/radius queries. Reach for rstar-python when
+you need to **mutate the index over time** or run **bounding-box queries** — with
+easy prebuilt wheels and no C/C++ system dependency.
+
+## Usage
+
+```python
+import numpy as np
+from rstar_python import PyRTree
+
+# Create a 3D R-tree
+tree = PyRTree(dims=3)
+
+# Insert points. insert() returns the point's id.
+tree.insert([1.0, 2.0, 3.0])            # -> 0  (auto-assigned)
+tree.insert([4.0, 5.0, 6.0], data=42)   # -> 42 (explicit id)
+
+# Or bulk-load (replaces existing contents). Accepts lists or numpy arrays,
+# and an optional list of ids.
+points = np.array([[1.0, 2.0, 3.0],
+                   [4.0, 5.0, 6.0],
+                   [7.0, 8.0, 9.0]], dtype=np.float64)
+tree.bulk_load(points, data=[10, 20, 30])
+
+# --- Coordinate-returning queries ---
+tree.nearest_neighbor([1.1, 2.1, 3.1])           # -> [1.0, 2.0, 3.0]
+tree.k_nearest_neighbors([1.1, 2.1, 3.1], k=2)   # -> [[...], [...]]
+tree.neighbors_within_radius([1.0, 2.0, 3.0], radius=1.0)
+tree.locate_in_envelope(min_corner=[0, 0, 0], max_corner=[2, 2, 2])
+
+# --- Vectorised, id-returning queries (scipy/sklearn style) ---
+query_pts = np.array([[1.1, 2.1, 3.1], [7.0, 8.0, 9.0]], dtype=np.float64)
+distances, ids = tree.query(query_pts, k=2)
+# distances: (2, 2) float64 Euclidean distances
+# ids:       (2, 2) int64 ids; padded with -1 / inf if fewer than k exist
+
+within = tree.query_radius(query_pts, radius=1.0)  # list of id lists
+
+# --- Bookkeeping ---
+len(tree)                  # number of points
+tree.dims                  # 3
+[1.0, 2.0, 3.0] in tree    # membership test
+tree.remove([1.0, 2.0, 3.0])
+```
+
+## Features
+
+- Points in 2–8 dimensions
+- Dynamic `insert` / `remove`
+- Per-point integer ids (auto-assigned or supplied)
+- Nearest-neighbour and k-nearest-neighbour queries
+- Radius search and axis-aligned bounding-box (envelope) queries
+- Vectorised `query` / `query_radius` over a numpy array of points, returning
+  distances and ids
+- Bulk loading (lists or numpy arrays) for fast construction
+- Type stubs (`py.typed`) for IDE and `mypy` support
+- Built on the fast Rust [rstar](https://github.com/georust/rstar) library
+
+## Development
+
+Requirements:
+- Rust (stable)
+- Python 3.10+
+- [maturin](https://github.com/PyO3/maturin)
+
+```bash
+git clone https://github.com/kephale/rstar-python
+cd rstar-python
+
+python -m venv .venv
+source .venv/bin/activate  # or `.venv\Scripts\activate` on Windows
+
+pip install maturin pytest numpy
+
+# Build and install in development mode
+maturin develop --release
+
+# Run tests
+pytest python/tests -v
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+

rstar_python-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+rstar_python/__init__.py,sha256=x-KHb-vmz4Hg-VAoy3IywKcNx-ISCaZAS_xU6ImN7sI,88
+rstar_python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rstar_python/rstar_python.pyd,sha256=yt-YjBaVpoXUWI6yJMzo0T1VRDSRECiBIghNKPgz-Cw,1132032
+rstar_python/rstar_python.pyi,sha256=7wSzm87JDk42-7aW4EWeUnaWcyCqTXXqBrKn1T-rz8I,2780
+rstar_python-0.1.0.dist-info/METADATA,sha256=4E07xqX6-I681XF4-uHAbjW9ii4qMkosqSSVYmq3kAQ,5547
+rstar_python-0.1.0.dist-info/WHEEL,sha256=OUT0XP5TL9Hq-6CIgsb5m6BAU8pfcNqYjx0xnFDWhNs,96
+rstar_python-0.1.0.dist-info/licenses/LICENSE,sha256=1vNK5wtdii97XWiIu-tGrewxnElyhROT7asu56sopuQ,1097
+rstar_python-0.1.0.dist-info/sboms/rstar-python.cyclonedx.json,sha256=PKodArq7zLicb7waKQy1SsiGrK8ZTywrjAa-TxdjtBs,39476
+rstar_python-0.1.0.dist-info/RECORD,,

rstar_python-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.13.3)
+Root-Is-Purelib: false
+Tag: cp310-abi3-win_amd64

rstar_python-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Kyle I S Harrington
+
+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.