Implement Stitch trait
#1087
Implement Stitch trait
#1087
Commits on Jul 26, 2024
-
feat: implement a stitch trait
This trait is a non-panicking alternative for the `BooleanOps::union` and actually doesn't modify the location of any of the coordinates. Instead it returns an error in failing scenarios. Co-Authored-By: RobWalt <robwalter96@gmail.com> Co-Authored-By: Azorlogh <bott.alix@gmail.com>
3 people committedJul 26, 2024 -
test: add test and fixup small details of algorithm
Co-Authored-By: RobWalt <robwalter96@gmail.com> Co-Authored-By: Azorlogh <bott.alix@gmail.com>
3 people committedJul 26, 2024 -
-
-
-
-
-
-
-
-
-
-
-
-
-
fix(review): doc comment formatting
Adding a code block around a ASCII drawing to preserve monospace rendering in docs. Authored-by: RobWalt <robwalter96@gmail.com>
-
chore(benches): add stitch benchmark
This benchmark was added to meassure performance improvements for the stitching algorithm. Authored-by: RobWalt <robwalter96@gmail.com>
-
perf(stitch): improve line comparison
The previous implementation created a whole new line to check if one of the lines was the inverse of the other. Removing this construction and inlining the function got us a good performance improvement. improvement: -27% Authored-by: RobWalt <robwalter96@gmail.com>
-
perf(stitch): n^2 loop to fold
Instead of iterating through all n^2 possibilities we can just iterate through the vector once (n^1) and kick out duplicates if we find some. This results in the same return values as before and is significantly faster. improvement: -88% Authored-by: RobWalt <robwalter96@gmail.com>
-
perf(stitch): idomatic std use
Making the code mildly more idiomatic resulted in performance gains. improvement: -8% Authored-by: RobWalt <robwalter96@gmail.com>
-
Minor removals of clones, but not really. It showed up as a small performance improvement in the benchmark but I'm not confident it's really an improvement. improvement: maybe -2.5% Authored-by: RobWalt <robwalter96@gmail.com>
-
fix(review): typo for consistency
Authored-by: RobWalt <robwalter96@gmail.com>
-
chore(comments): add perf comments
Leave some nice comments for the after world and also tell the future developers to benchmark their optimizations! Authored-by: RobWalt <robwalter96@gmail.com>
-
docs(stitch): clarify edge cases
In the review process we figured that this still was a bit ambiguous. Authored-by: RobWalt <robwalter96@gmail.com>
-
adding more details to the `find_boundary_lines` functions since it's quiet important for performance to get the cencepts right there Authored-by: RobWalt <robwalter96@gmail.com>
-
refactor(stitch): macro function dispatch
Factor out common code and call it directly in the `Triangle` and `MultiPolygon` impls to prevent needless cloning and indirection. Authored-by: RobWalt <robwalter96@gmail.com>
-
chore(cleanup): docs + simplifications
Authored-by: RobWalt <robwalter96@gmail.com>
-
fix(review): special case the algo to triangles only
As stated in one of the review comments, the main purpose of the algo is to stitch together triangles that resulted from a triangulation. Although it would also be nice to generalize the algo for polygons and multi polygons, it makes the code harder to read. It is advised to just triangulate in those cases and then run the stitching on the compound triangulation. On another note: special casing the algorithm to triangles also gave us a real good performance boost again. We gained another ~50% boost from all of the improvements in this commit. Authored-by: RobWalt <robwalter96@gmail.com>
-
chore(cleanup): use pr suggestions
Authored-by: RobWalt <robwalter96@gmail.com>
-
-
Authored-by: RobWalt <robwalter96@gmail.com>
-
fix(review): don't use custom capacity
Authored-by: RobWalt <robwalter96@gmail.com>
-
chore(cleanup): remove unused error variants
Authored-by: RobWalt <robwalter96@gmail.com>
-
feat(visibility): make it all pub(crate)
We decided to do this since we're not sure yet about how users might use this functionality. In the worst case the API is still confusing and leads to a lot of error reports due to the implicit assumptions which are only documented in doc strings and not enforced by code or won't be caught by errors Authored-by: RobWalt <robwalter96@gmail.com>
-
docs(stitch): improve doc string
Add some notes that triangles shouldn't even overlap instead of just stating that duplicates are not allowed. Authored-by: RobWalt <robwalter96@gmail.com>
-
Authored-by: RobWalt <robwalter96@gmail.com>
-
chore(cleanup): comment benchmark out
This benchmark needs a public export of the stitch trait which isn't given anymore. I added some comments for the after world. Authored-by: RobWalt <robwalter96@gmail.com>
-
fix(tests): comment out failing doc test
Authored-by: RobWalt <robwalter96@gmail.com>
-
refactor(helpers): move triangle winding function
Authored-by: RobWalt <robwalter96@gmail.com>
-
chore: improve explaining comment
Authored-by: RobWalt <robwalter96@gmail.com>
-
chore(tests): use
Relatefor testingAuthored-by: RobWalt <robwalter96@gmail.com>
-
-
-
