Skip to main content

Rust-accelerated quadtree for Python with fast inserts, range queries, and k-NN search.

Project description

fastquadtree

Interactive Screenshot

Rust-optimized quadtree with a clean Python API

👉 Check out the Docs: https://elan456.github.io/fastquadtree/

PyPI Python versions Downloads Build No runtime deps

PyO3 maturin Ruff

Docs Wheels Coverage License: MIT


Why use fastquadtree

  • Just pip install: prebuilt wheels for Windows, macOS, and Linux (no Rust or compiler needed)
  • The fastest quadtree Python package (>10x faster than pyqtree)
  • Clean Python API with no external dependencies and modern typing hints
  • Support for inserting bounding boxes or points
  • Fast KNN and range queries
  • Optional object tracking for id ↔ object mapping
  • Fast serialization to/from bytes
  • Support for multiple data types (f32, f64, i32, i64) for coordinates
  • 100% test coverage and CI on GitHub Actions
  • Offers a drop-in pyqtree shim that is 6.791x faster while keeping the same API

Examples

See examples of how fastquadtree can be used in the runnables section.

Install

pip install fastquadtree
from fastquadtree import QuadTree  # Point handling
from fastquadtree import RectQuadTree  # Bounding box handling
from fastquadtree.pyqtree import Index  # Drop-in pyqtree shim (6.791x faster while keeping the same API)

Benchmarks

fastquadtree outperforms all other quadtree Python packages, including the Rtree spatial index.

Library comparison

Total time Throughput

Summary (largest dataset, PyQtree baseline)

  • Points: 500,000, Queries: 500
  • Fastest total: fastquadtree at 0.067 s
Library Build (s) Query (s) Total (s) Speed vs PyQtree
fastquadtree 0.050 0.017 0.067 44.95×
Shapely STRtree 0.209 0.103 0.312 9.58×
fastquadtree (obj tracking) 0.289 0.178 0.467 6.41×
nontree-QuadTree 0.878 1.030 1.908 1.57×
Rtree 1.742 0.523 2.265 1.32×
e-pyquadtree 1.425 0.975 2.400 1.25×
quads 2.094 0.782 2.876 1.04×
PyQtree 2.607 0.385 2.992 1.00×

See the benchmark section for details, including configurations, system info, and native vs shim benchmarks.

Quickstart

See the quickstart guide

API

See the full API

QuadTree(bounds, capacity, max_depth=None, track_objects=False, dtype="f32")

  • 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.
  • dtype — data type for coordinates, e.g., "f32", "f64", "i32", "i64"

Key Methods

  • insert(xy, *, obj=None) -> int

  • query(rect, *, as_items=False) -> list

  • nearest_neighbor(xy, *, as_item=False) -> (id, x, y) | Item | None

  • delete(id, xy) -> bool

There are more methods and object tracking versions in the docs.

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 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 for overhead details.

Pygame Ball Pit Demo

Ballpit_Demo_Screenshot

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.

See the runnables guide for setup instructions.

FAQ

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) 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? Yes, you can store rectangles using the RectQuadTree class. Circles can be approximated with bounding boxes. See the RectQuadTree docs for details.

Do I need NumPy installed?
No, NumPy is a fully optional dependency. If you do have NumPy installed, you can use methods such as query_np and the NumPy array variant of insert_many for better performance. The Rust core is able to handle NumPy arrays faster than Python lists, so there's a lot of time savings in utilizing the NumPy functions. See the Native vs Shim benchmark for details on how returing NumPy arrays can speed up queries.

Does fastquadtree support multiprocessing?
Yes, fastquadtree objects can be serialized to bytes using the to_bytes() method and deserialized back using from_bytes(). This allows you to share quadtree data across processes and even cache prebuilt trees to disk. See the interactive v2 demo for an example of saving and loading a quadtree.

License

MIT. See LICENSE.

Acknowledgments

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fastquadtree-1.5.1.tar.gz (870.1 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

fastquadtree-1.5.1-cp38-abi3-win_amd64.whl (276.9 kB view details)

Uploaded CPython 3.8+Windows x86-64

fastquadtree-1.5.1-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (386.5 kB view details)

Uploaded CPython 3.8+manylinux: glibc 2.17+ x86-64

fastquadtree-1.5.1-cp38-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl (416.9 kB view details)

Uploaded CPython 3.8+manylinux: glibc 2.17+ ARMv7l

fastquadtree-1.5.1-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (376.0 kB view details)

Uploaded CPython 3.8+manylinux: glibc 2.17+ ARM64

fastquadtree-1.5.1-cp38-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl (679.8 kB view details)

Uploaded CPython 3.8+macOS 10.12+ universal2 (ARM64, x86-64)macOS 10.12+ x86-64macOS 11.0+ ARM64

File details

Details for the file fastquadtree-1.5.1.tar.gz.

File metadata

  • Download URL: fastquadtree-1.5.1.tar.gz
  • Upload date:
  • Size: 870.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: maturin/1.10.2

File hashes

Hashes for fastquadtree-1.5.1.tar.gz
Algorithm Hash digest
SHA256 c70c1290d7c2309b05f0491755030319ecba6386dc173f82c9edd32df405d42a
MD5 6c48bb05042df39e08337103668fa238
BLAKE2b-256 83ce58603152ef534e28d95901d46fe16715e6ed649f0c0deb96bdf38dee6a20

See more details on using hashes here.

File details

Details for the file fastquadtree-1.5.1-cp38-abi3-win_amd64.whl.

File metadata

File hashes

Hashes for fastquadtree-1.5.1-cp38-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 e490f6dfc4a82e8a1fa19b77f773a5ae39253114c6ccbe972b2a447e5f254ddb
MD5 58101fa76fa80e0f191b7781bc15e7e8
BLAKE2b-256 39c9f4e1409c196d974a15c2f913fd82228810757ce2b125c83af988aeaf08ba

See more details on using hashes here.

File details

Details for the file fastquadtree-1.5.1-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for fastquadtree-1.5.1-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 98e0b819668454c6e604602a69232e0e88f9b7f4b7ebf4f081300f2b4aee069a
MD5 5cd06832354a5cea6d75eae5ddd78b2c
BLAKE2b-256 47793265cbdc350f3f694b82aeeb245452ca168bf040790f170eec23a9715385

See more details on using hashes here.

File details

Details for the file fastquadtree-1.5.1-cp38-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl.

File metadata

File hashes

Hashes for fastquadtree-1.5.1-cp38-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
Algorithm Hash digest
SHA256 af19ef2416a0619fd5c273322162ac1a90814b642ad2f123d354499feac29d53
MD5 10c35c9698d3ec382613cb2f16500fda
BLAKE2b-256 656ca9afd498071c3c06c372aebb41e713f70456b88c0801c3e5402313d34099

See more details on using hashes here.

File details

Details for the file fastquadtree-1.5.1-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for fastquadtree-1.5.1-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 b2939ed9c289a30db73c8136232837b0552d8b94aac85f03361ba6e4e23ecd5c
MD5 75c7fe3790a15687b3e8398ace1e6420
BLAKE2b-256 6978a858a1491ebd9c2d1f47e959fcca583c63b837477004e2a77633b1b4e43c

See more details on using hashes here.

File details

Details for the file fastquadtree-1.5.1-cp38-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl.

File metadata

File hashes

Hashes for fastquadtree-1.5.1-cp38-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl
Algorithm Hash digest
SHA256 2757ed0cf52967ed41c3fac6e5993e324b6cdffef07bd4159ffffad5dd738063
MD5 ab0db0256214828ff63748230cdfbb30
BLAKE2b-256 c5cc444a1355324a80aa3e007c6a36c55643c47eee83dcd716881751f5d383d2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page