Use [T; 2] as a vertex + some optimizations

[ciscorn]

• Use [{float};2] as a vertex instead of flattened {float} for better performance.
• Some other optimizations.

[coderabbitai]

Walkthrough

The recent updates encompass enhancements in the mapbox/earcut Rust port, including performance improvements, new features for 3D polygon handling, and refined data structures. Key changes include version upgrades in dependencies, better data handling in benchmarks and examples, and significant internal refactoring for efficiency and safety in core functionalities.

Changes

Files	Change Summary
Cargo.toml	Updated num-traits to 0.2 with no-default-features and earcut to 0.4.0.
README.md, src/lib.rs	Enhanced triangulation features, introduced NodeIndex, and refined polygon handling algorithms.
benches/..., examples/...	Simplified data handling and removed redundant processing steps.
tests/...	Adjusted data structures and processing in test setups for better accuracy and performance.

🐇✨
A hop of code, a leap of version,
Triangles dance in new precision.
From 2D planes to 3D space,
Our polygons find their perfect place.
With every commit, a small delight,
In Rust we trust, to code it right! 🌟
🐇✨

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between c782a9a and 8752adb.

Files selected for processing (7)

• Cargo.toml (2 hunks)
• README.md (1 hunks)
• benches/benchmark.rs (2 hunks)
• examples/example.rs (1 hunks)
• src/lib.rs (31 hunks)
• tests/fixture.rs (1 hunks)
• tests/simple.rs (11 hunks)

Files skipped from review due to trivial changes (1)

• examples/example.rs

Additional comments not posted (23)

Cargo.toml (2)

12-12: Updated num-traits dependency to version 0.2 with no-default-features set to true to optimize dependency management.

---

3-3: Updated earcut package to version 0.4.0.

README.md (2)

10-10: Clarified that internal buffers and output index vectors can be reused for multiple triangulations, enhancing performance.

---

11-11: Updated the description of the utils3d module to specify that it handles 3D coplanar polygons, providing clearer information on its functionality.

benches/benchmark.rs (1)

7-15: Refactored load_fixture function to use a new data structure for coordinates, simplifying data processing and potentially improving performance.

tests/fixture.rs (1)

13-13: Updated the data variable type in test functions to a vector of arrays of f64 with size 2, improving data handling and clarity.

tests/simple.rs (1)

9-9: Simplified data passing to the earcut function by using copied() instead of flatten().copied(), enhancing clarity and potentially improving performance.

src/lib.rs (16)

10-10: Introducing NonZeroU32 for NodeIndex enhances performance by enabling certain optimizations such as memory layout improvements.

---

46-55: Ensure that the use of unsafe block and get_unchecked is justified and safe here. The debug_assert! provides some safety, but consider if there are any edge cases where the index might exceed bounds.

---

74-74: Definition of NodeIndex as NonZeroU32 is a good use of Rust's type system to ensure that zero is never a valid index, which can help prevent bugs.

---

86-92: Usage of NodeIndex in the Node struct for linking nodes is a significant improvement for safety and clarity.

---

141-141: Adding a dummy node at the start can be a clever way to simplify some algorithms by avoiding special cases for empty data structures.

---

149-160: The refactoring of the earcut function to use the new data structure and NodeIndex improves type safety and clarity. However, ensure comprehensive testing to verify that the behavior remains consistent with these changes.

---

174-174: The conditional handling in linkedList function is crucial. Ensure that the logic correctly handles both cases (clockwise and counter-clockwise) as intended.

---

190-203: The calculation for bounding box and subsequent operations are critical for performance in the earcut algorithm. Verify that these calculations are accurate and consider edge cases where the data might lead to incorrect computations.

---

314-351: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [300-348]

The main loop in earcut_linked function is complex and involves multiple conditions and branches. It's important to ensure that each step, especially the ear checking and removal, is correct and efficient. Consider adding more comments to explain the logic in detail.

---

570-684: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [371-752]

The geometric functions like is_ear, intersects, and on_segment are fundamental to the algorithm's correctness. It's crucial to ensure that these functions are both correct and efficient. Consider adding unit tests specifically for these functions to cover various geometric scenarios.

---

816-852: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [791-849]

The eliminate_hole function is a critical part of handling complex polygons with holes. Ensure that the logic for finding and linking holes is robust and handles all edge cases.

---

905-929: The filter_points function removes unnecessary points from the data structure, which can lead to significant performance improvements. Ensure that this function does not remove necessary points, which could alter the shape of the polygon.

---

936-939: The split_polygon function modifies the data structure significantly. It's important to ensure that these modifications are correct and do not introduce any inconsistencies in the data structure.

---

963-976: The insert_node function is used to add new nodes to the data structure. Ensure that the links between nodes are correctly maintained to prevent any issues with the data structure's integrity.

---

988-988: The remove_node function is crucial for maintaining the data structure's integrity during modifications. Ensure that all links are correctly updated to prevent any issues.

---

1010-1050: The deviation function calculates the difference between the polygon area and its triangulation. This is a critical function for verifying the correctness of the triangulation. Ensure that the calculations are accurate and consider adding tests to verify this function's correctness.

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.55%. Comparing base (c782a9a) to head (8752adb).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #11      +/-   ##
==========================================
+ Coverage   99.53%   99.55%   +0.01%     
==========================================
  Files           2        2              
  Lines         868      891      +23     
==========================================
+ Hits          864      887      +23     
  Misses          4        4              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[coderabbitai]

Actionable comments posted: 1