feat(WIP): Add Chebyshev distance ($L_∞$ norm) support

.commitlintrc.yaml

@@ -0,0 +1,3 @@
+extends:
+  - "@commitlint/config-conventional"
+

.github/workflows/build.yml

@@ -1,6 +1,11 @@
 name: CI
 
-on: [push]
+on:
+  push:
+    branches: [ "**" ]
+  pull_request:
+    branches: [ "**" ]
+  workflow_dispatch:
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -10,12 +15,21 @@ env:
   LATEST_STABLE_RUST_VERSION: "TBD"
 
 jobs:
+  commitlint:
+    name: Commit Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: wagoid/commitlint-github-action@v6
+        with:
+          configFile: .commitlintrc.yaml
+
   format:
     name: Formatting
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           show-progress: false
 
@@ -44,7 +58,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           show-progress: false
 
@@ -80,7 +94,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           show-progress: false
 
@@ -115,7 +129,7 @@ jobs:
     name: Cargo Check (Stable)
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           show-progress: false
 
@@ -149,7 +163,7 @@ jobs:
     name: Cargo Check (Nightly)
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           show-progress: false
 
@@ -185,7 +199,7 @@ jobs:
     name: Run Tests (Stable, no crate features enabled that require unstable Rust)
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           show-progress: false
 
@@ -218,7 +232,7 @@ jobs:
     name: Run Tests (Nightly, all features enabled)
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           show-progress: false
 

.github/workflows/codspeed.yml

@@ -12,7 +12,7 @@ jobs:
   benchmarks:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           show-progress: false
 
@@ -27,7 +27,7 @@ jobs:
         run: cargo codspeed build
 
       - name: Run the benchmarks
-        uses: CodSpeedHQ/action@v3
+        uses: CodSpeedHQ/action@v4
         with:
           run: cargo codspeed run
           token: ${{ secrets.CODSPEED_TOKEN }}

.github/workflows/coverage.yml

@@ -1,6 +1,11 @@
 name: Coverage
 
-on: [push]
+on:
+  push:
+    branches: [ "**" ]
+  pull_request:
+    branches: [ "**" ]
+  workflow_dispatch:
 
 env:
   CARGO_TERM_COLOR: always
@@ -10,7 +15,7 @@ jobs:
     name: Test Coverage
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           show-progress: false
 

.github/workflows/pre-release-string-updater.yml

@@ -12,7 +12,7 @@ jobs:
     name: Pre Release String Updater
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           show-progress: false
 
@@ -50,7 +50,7 @@ jobs:
           git commit -a -m "chore: update version references"
 
       - name: Push changes
-        uses: ad-m/github-push-action@v0.8.0
+        uses: ad-m/github-push-action@v1.0.0
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           branch: ${{ github.ref }}

.github/workflows/pre-release.yml

@@ -13,9 +13,10 @@ jobs:
       pull-requests: write
       contents: write
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           show-progress: false
+          fetch-depth: 0
 
       - name: Get date
         run: |

.github/workflows/release.yml

@@ -10,7 +10,7 @@ jobs:
     if: ${{ github.event.pull_request.merged && contains(github.event.pull_request.labels.*.name, 'release') }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           show-progress: false
 

CHANGELOG.md

@@ -1,5 +1,66 @@
 # Kiddo Changelog
 
+## Unreleased
+
+I've kept back these changes for now as, whilst extremely welcome, the change to the return type of `size()` would be breaking.
+I'm hoping to have v6 available soon, which will include both these changes as well as addressing quite a few other long-running feature requests.
+
+### ✨ Features
+
+- Improve the flexibility of T type, KdTree.size. Add generate nearest_one_point (https://github.com/sdd/kiddo/pull/214, @pjkundert)
+- Fix broken test of custom struct as T. Add test for `()` as T (https://github.com/sdd/kiddo/pull/243 @pjkundert)
+
+## [5.2.4] - 2026-01-01 (Happy New Year! 🎉)
+
+### Deps
+
+- update cmov dep from 0.3 to 0.4 after 0.3 got yanked (see https://github.com/RustCrypto/utils/issues/1304). Thanks @yuby and @jqnatividad
+
+## [5.2.3] - 2025-12-08
+
+### 🐛 Bug Fixes
+
+- Correct slice access in remainder processing and remove unsafe (@MarkusZoppelt)
+- Use `try_from()` with error for `leaf_items.len()` (@MarkusZoppelt)
+
+### ♻️ Refactor
+
+- within_unsorted_iter no longer uses a generator (@KvA2KLvAST)
+- Remove needless SubAssign trait bound from Content trait
+
+### Deps
+
+- Remove doc-comment dependency and use doc attribute that was added in Rust 1.54 instead (@jqnatividad)
+- Use `doc` attribute instead of `doc_comment!` (@jqnatividad)
+- Update actions/checkout action to v6
+- Update codspeedhq/action action to v4
+- Update ad-m/github-push-action action to v1
+- Update rust crate rstest to 0.26
+- Update rust crate codspeed-criterion-compat to v4
+
+### Ci
+
+- Update CI workflow triggers to include PR and workflow_dispatch
+- Permit coverage to run for PRs as well
+- Fix release-plz and add commitlint
+
+### 💄 Styling
+
+- Remove unnecessary parentheses
+- Fix formatting
+- Fix some lint issues
+
+### 🧪 Testing
+
+- Add regression test for remainder slice access bug (@MarkusZoppelt)
+
+## [5.2.2] - 2025-06-30
+
+### ♻️ Refactor
+
+- refactor `within_unsorted_iter` to decouple the lifetime of the iterator from that of the query by
+  copying `query` once at the start of the call (@KvA2KLvAST)
+
 ## [5.2.1] - 2025-06-29
 
 ### 📝 Documentation

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "kiddo"
-version = "5.2.1"
+version = "5.2.4"
 edition = "2021"
 authors = ["Scott Donnelly <scott@donnel.ly>"]
 description = "A high-performance, flexible, ergonomic k-d tree library. Ideal for geo- and astro- nearest-neighbour and k-nearest-neighbor queries"
@@ -27,16 +27,15 @@ opt-level = 3
 aligned-vec = "0.6.1"
 array-init = "2.1.0"
 az = "1"
-cmov = "0.3"
+cmov = "0.4"
 divrem = "1"
-doc-comment = "0.3"
 num-traits = "0.2"
 ordered-float = "5"
 sorted-vec = "0.8"
 
 [dev-dependencies]
 bincode = {  version = "2", features = ["serde"] }
-codspeed-criterion-compat = "2.10"
+codspeed-criterion-compat = "4.0"
 criterion = "0.6"
 elapsed = "0.1.2"
 flate2 = { version = "1", features = ["zlib-ng-compat"], default-features = false }
@@ -48,7 +47,7 @@ radians = "0.3"
 rand = "0.9"
 rand_distr = "0.5"
 rayon = "1"
-rstest = "0.25"
+rstest = "0.26"
 serde = { version = "1", features = ["derive", "rc"] }
 serde_json = "1"
 ubyte = "0.10"

README.md

@@ -27,7 +27,7 @@ Kiddo provides:
 Add `kiddo` to `Cargo.toml`
 ```toml
 [dependencies]
-kiddo = "5.2.0"
+kiddo = "5.2.4"
 ```
 
 Add points to k-d tree and query nearest n points with distance function

examples/cities.rs

@@ -190,7 +190,7 @@ fn main() -> Result<(), Box<dyn Error>> {
     let dist = kilometres_to_unit_sphere_squared_euclidean(1000.0);
     let best_3_iter = kdtree.best_n_within::<SquaredEuclidean>(&query, dist, 3);
     let best_3 = best_3_iter
-        .map(|neighbour| (&cities[neighbour.item].name))
+        .map(|neighbour| &cities[neighbour.item].name)
         .collect::<Vec<_>>();
     println!("\nMost populous 3 cities within 1000km of 0N, 0W: {best_3:?}");
 

git-cliff.toml

@@ -40,6 +40,7 @@ commit_parsers = [
     { message = "^refactor", group = "♻️ Refactor"},
     { message = "^style", group = "💄 Styling"},
     { message = "^test", group = "🧪 Testing"},
+    { message = "^chore", group = "🧹 Chore"},
 ]
 protect_breaking_commits = true
 tag_pattern = "v[0-9]\\.[0-9]\\.[0-9]"

release-plz.toml

@@ -1,10 +1,5 @@
 [workspace]
-allow_dirty = false
 changelog_config = "git-cliff.toml" # use a custom git-cliff configuration
-changelog_update = true # disable changelog updates
 dependencies_update = true # update dependencies with `cargo update`
-git_release_enable = true # disable GitHub/Gitea releases
 pr_labels = ["release"] # add the `release` label to the release Pull Request
-publish = true
-publish_allow_dirty = false
-semver_check = true # disable API breaking changes checks
+

src/common/generate_best_n_within.rs

@@ -2,8 +2,7 @@
 #[macro_export]
 macro_rules! generate_best_n_within {
     ($leafnode:ident, $comments:tt) => {
-    doc_comment! {
-    concat!$comments,
+    #[doc = concat!$comments]
     #[inline]
     pub fn best_n_within<D>(
         &self,
@@ -77,7 +76,7 @@ macro_rules! generate_best_n_within {
                 rd,
             );
 
-            rd = Axis::rd_update(rd, D::dist1(new_off, old_off));
+            rd = D::accumulate(rd, D::dist1(new_off, old_off));
 
             if rd <= radius {
                 off[split_dim] = new_off;
@@ -147,4 +146,5 @@ macro_rules! generate_best_n_within {
             }
         }
     }
-}}}
+    };
+}

src/common/generate_nearest_n.rs

@@ -2,8 +2,7 @@
 #[macro_export]
 macro_rules! generate_nearest_n {
     ($comments:tt) => {
-    doc_comment! {
-    concat!$comments,
+    #[doc = concat!$comments]
     #[inline]
     pub fn nearest_n<D>(&self, query: &[A; K], qty: usize) -> Vec<NearestNeighbour<A, T>>
     where
@@ -66,7 +65,7 @@ macro_rules! generate_nearest_n {
                 rd,
             );
 
-            rd = Axis::rd_update(rd, D::dist1(new_off, old_off));
+            rd = D::accumulate(rd, D::dist1(new_off, old_off));
 
             if Self::dist_belongs_in_heap(rd, results) {
                 off[split_dim] = new_off;
@@ -113,8 +112,9 @@ macro_rules! generate_nearest_n {
         }
     }
 
-    #[inline]
+    #[inline(always)]
     fn dist_belongs_in_heap(dist: A, heap: &BinaryHeap<NearestNeighbour<A, T>>) -> bool {
         heap.is_empty() || dist < heap.peek().unwrap().distance || heap.len() < heap.capacity()
     }
-}}}
+    };
+}