fastquadtree 1.0.0__tar.gz → 1.0.2__tar.gz

{fastquadtree-1.0.0 → fastquadtree-1.0.2}/Cargo.lock

@@ -10,7 +10,7 @@ checksum = "c08606f8c3cbf4ce6ec8e28fb0014a2c086708fe954eaa885384a6165172e7e8"
 
 [[package]]
 name = "fastquadtree"
-version = "1.0.0"
+version = "1.0.2"
 dependencies = [
  "pyo3",
  "smallvec",

{fastquadtree-1.0.0 → fastquadtree-1.0.2}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "fastquadtree"
-version = "1.0.0"
+version = "1.0.2"
 edition = "2021"
 readme = "README.md"
 

{fastquadtree-1.0.0 → fastquadtree-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastquadtree
-Version: 1.0.0
+Version: 1.0.2
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Rust

fastquadtree-1.0.2/docs/api/pyqtree.md

@@ -0,0 +1,4 @@
+# fastquadtree.pyqtree
+::: fastquadtree.pyqtree.Index
+    options:
+        inherited_members: true

fastquadtree-1.0.2/docs/future_features.md

@@ -0,0 +1,30 @@
+# Future Features
+
+Below are a list of features that may be added to future versions of this project. 
+If you really want any of these features, please let us know by opening an issue.
+
+If you have any suggestions or would like to contribute, please feel free to open an issue or a pull request.
+
+## Planned Features
+
+### 1. Quadtree serialization
+
+By serializing the quadtree, we can save its state to a file and load it later. This will allow us to persist the quadtree structure and data across sessions. For example, you could pre build a quadtree with all the walls in your video game level, serialize it to a file, and then load it when the game starts. This will heavily reduce the game load time since you won't have to rebuild the quadtree from scratch every time.
+
+### 2. Circle support
+
+Currently, we support points and rectangles in two separate quadtrees.
+For example, in the ball-pit demo, we use a point quadtree, but then query a larger area to account for the radius of the balls.
+With a circle quadtree, we could directly insert circles and perform circle-circle collision detection.
+
+### 3. KNN with criteria function
+
+Currently, KNN only supports finding the nearest neighbors based on euclidean distance.
+By adding a criteria function, we could allow users to define custom criteria for finding neighbors by passing a function that 
+takes in a point and returns a score. The KNN algorithm would then use this score to determine the nearest neighbors.
+
+### 4. KNN in rectangle quadtree
+
+Currently, KNN is only supported in the point quadtree. By adding KNN support to the rectangle quadtree, we could allow users to find the nearest rectangles to a given point. This would be to the nearest edge of the rectangle, adding complexity to the algorithm.
+However, it will allow for really quick collision detection between a point and a set of rectangles as the point can just do
+robust-collision handling with the nearest rectangles.

fastquadtree-1.0.2/docs/styles/overrides.css

@@ -0,0 +1,38 @@
+/* Global typography tuning */
+:root {
+  /* Larger base size for body copy */
+  --md-typeset-font-size: 0.98rem;   /* default ~0.9-0.95 */
+}
+
+.md-typeset {
+  line-height: 1.65;                 /* more relaxed, better for focus */
+  letter-spacing: 0.001em;
+}
+
+/* Crisper headings without looking heavy */
+.md-typeset h1, .md-typeset h2, .md-typeset h3 {
+  font-weight: 700;
+  line-height: 1.25;
+}
+
+/* Improve contrast on body text and links */
+:root {
+  --md-default-fg-color:          rgba(0,0,0,0.86);
+  --md-default-fg-color--light:   rgba(0,0,0,0.64);
+  --md-typeset-a-color:           #1e40af;  /* indigo-800 like */
+}
+[data-md-color-scheme="slate"] {
+  --md-default-fg-color:          rgba(255,255,255,0.92);
+  --md-default-fg-color--light:   rgba(255,255,255,0.72);
+  --md-typeset-a-color:           #93c5fd;  /* lighter link on dark */
+}
+
+/* Make code a tad larger for readability */
+.md-typeset code, .md-typeset pre code {
+  font-size: 0.93em;
+}
+
+/* Slightly stronger nav text */
+.md-nav__item .md-nav__link {
+  font-weight: 500;
+}

{fastquadtree-1.0.0 → fastquadtree-1.0.2}/mkdocs.yml

@@ -15,10 +15,18 @@ theme:
     - toc.integrate
     - search.suggest
     - search.highlight
+    - content.tooltips
   palette:
     - scheme: slate
       primary: indigo
       accent: deep orange
+  font:
+    text: Inter
+    code: JetBrains Mono
+
+extra_css:
+  - styles/overrides.css
+
 
 plugins:
   - search
@@ -36,6 +44,11 @@ plugins:
             separate_signature: true
             line_length: 88
             heading_level: 2
+            filters:  # Exclude __slots__ and __len__ and anything with a single underscore prefix
+              - "!__slots__"
+              - "!__len__"
+              - "!_.*"
+              
   - autorefs
   - git-revision-date-localized:
       fallback_to_build_date: true
@@ -68,11 +81,13 @@ nav:
   - Quickstart: quickstart.md
   - Runnables: runnables.md
   - Benchmark: benchmark.md
+  - Future Features: future_features.md
   - API:
-      - fastquadtree.QuadTree: api/quadtree.md
-      - fastquadtree.RectQuadTree: api/rect_quadtree.md
-      - fastquadtree.RectItem: api/rect_item.md
-      - fastquadtree.PointItem: api/point_item.md
+      - QuadTree: api/quadtree.md
+      - RectQuadTree: api/rect_quadtree.md
+      - pyqtree: api/pyqtree.md
+      - RectItem: api/rect_item.md
+      - PointItem: api/point_item.md
 
 extra:
   social:
@@ -82,5 +97,4 @@ extra:
       link: https://pypi.org/project/fastquadtree/
 
 # Build options
-extra_css: []
 extra_javascript: []

{fastquadtree-1.0.0 → fastquadtree-1.0.2}/pysrc/fastquadtree/_item.py

@@ -23,17 +23,22 @@ class Item:
     __slots__ = ("geom", "id_", "obj")
 
     def __init__(self, id_: int, geom: Point | Bounds, obj: Any | None = None):
-        self.id_ = id_
-        self.geom = geom
-        self.obj = obj
+        self.id_: int = id_
+        self.geom: Point | Bounds = geom
+        self.obj: Any | None = obj
 
 
 class PointItem(Item):
     """
     Lightweight point item wrapper for tracking and as_items results.
+
+    Attributes:
+        id_: Integer identifier.
+        geom: The point geometry as (x, y).
+        obj: The attached Python object if available, else None.
     """
 
-    __slots__ = ("geom", "id_", "obj", "x", "y")
+    __slots__ = ("x", "y")
 
     def __init__(self, id_: int, geom: Point, obj: Any | None = None):
         super().__init__(id_, geom, obj)
@@ -43,9 +48,14 @@ class PointItem(Item):
 class RectItem(Item):
     """
     Lightweight rectangle item wrapper for tracking and as_items results.
+
+    Attributes:
+        id_: Integer identifier.
+        geom: The rectangle geometry as (min_x, min_y, max_x, max_y
+        obj: The attached Python object if available, else None.
     """
 
-    __slots__ = ("geom", "id_", "max_x", "max_y", "min_x", "min_y", "obj")
+    __slots__ = ("max_x", "max_y", "min_x", "min_y")
 
     def __init__(self, id_: int, geom: Bounds, obj: Any | None = None):
         super().__init__(id_, geom, obj)

{fastquadtree-1.0.0 → fastquadtree-1.0.2}/pysrc/fastquadtree/pyqtree.py

@@ -48,14 +48,17 @@ class Index:
     all the quad instances and lets you access their properties.
 
     Example usage:
+    ```python
+    from fastquadtree.pyqtree import Index
 
-    >>> spindex = Index(bbox=(0, 0, 100, 100))
-    >>> spindex.insert('duck', (50, 30, 53, 60))
-    >>> spindex.insert('cookie', (10, 20, 15, 25))
-    >>> spindex.insert('python', (40, 50, 95, 90))
-    >>> results = spindex.intersect((51, 51, 86, 86))
-    >>> sorted(results)
-    ['duck', 'python']
+
+    spindex = Index(bbox=(0, 0, 100, 100))
+    spindex.insert('duck', (50, 30, 53, 60))
+    spindex.insert('cookie', (10, 20, 15, 25))
+    spindex.insert('python', (40, 50, 95, 90))
+    results = spindex.intersect((51, 51, 86, 86))
+    sorted(results) # ['duck', 'python']
+    ```
     """
 
     __slots__ = ("_free", "_item_to_id", "_objects", "_qt")