v3.0.0

[sdd]

• feat!: queries return structs instead of tuples. Query methods have been updated so that they all return either a NearestNeighbour, Vec<NearestNeighbour>, or Vec<BestNeighbour>, for consistency.
• feat!: use a trait instead of a function pointer for distance metrics
• feat: add within_unsorted_into_iter query
• perf: refactor within to simply sort the result of within_unsorted. Previously, within was keeping its results in a BinaryHeap and calling its into_sorted_vec method to, well, return a sorted Vec. Whilst a BinaryHeap is great if you are frequently adding and removing items, if your use case is to gradually add all your items, and then sort them all at once, its quicker to just put things in a Vec and then sort the Vec at the end. Benchmarking shows that this change improves performance by anything from 5 to 60% in practice.

[codecov-commenter]

Codecov Report

Merging #71 (d4286b1) into master (e1489a7) will increase coverage by 8.57%. The diff coverage is 90.75%.

@@            Coverage Diff             @@
##           master      #71      +/-   ##
==========================================
+ Coverage   83.91%   92.48%   +8.57%     
==========================================
  Files          29       44      +15     
  Lines        3593     5589    +1996     
  Branches        0     5589    +5589     
==========================================
+ Hits         3015     5169    +2154     
+ Misses        578      390     -188     
- Partials        0       30      +30     

Files Changed	Coverage Δ
src/mirror_select_nth_unstable_by.rs	99.43% <ø> (ø)
src/immutable/float/construction.rs	42.59% <42.59%> (ø)
src/fixed/distance.rs	53.57% <53.57%> (+30.31%)	:arrow_up:
src/fixed/query/within_unsorted_iter.rs	79.43% <79.43%> (ø)
src/immutable/float/kdtree.rs	82.56% <82.56%> (ø)
src/immutable/float/query/approx_nearest_one.rs	85.71% <85.71%> (ø)
src/best_neighbour.rs	89.18% <89.18%> (ø)
src/nearest_neighbour.rs	89.18% <89.18%> (ø)
src/immutable/float/query/best_n_within.rs	89.31% <89.31%> (ø)
src/float/query/within_unsorted_iter.rs	93.10% <93.10%> (ø)
... and 31 more

... and 6 files with indirect coverage changes

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more