Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update readme #66

Merged
merged 1 commit into from
Oct 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added Documentation~/benchmark-constraint.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Documentation~/benchmark-delaunay.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Documentation~/benchmark-refinement.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ using var triangulator = new(1024, Allocator.Persistent)
// If true constrains edges defined in the Triangulator.Input.ConstraintEdges
ConstrainEdges = false;
// If true and provided Triangulator.Input is not valid, it will throw an exception.
// The error can be catch by using the `Triangulator.Output.Status`.
ValidateInput = true;
// Type of preprocessing algorithm, see the section below for more details.
Preprocessor = Triangulator.Preprocessor.None;
Expand Down Expand Up @@ -387,6 +388,11 @@ Below, you'll find a performance comparison (with Burst enabled) between `v2.0.0

![Delaunay Benchmark](Documentation~/benchmark-delaunay.png)

Below, you can find a benchmark for constrained triangulation for both `v2.1` and `v2.2`. The test specimen consists of a 100×100 grid with additional `#constraints`-points distributed in a circle at the center of the grid. In some cases of `v2.1`, the algorithm gets stuck. Reference timings for non-constrained triangulation are marked with a gray line.
In the figure below, you can also see example test cases: red represents resulting triangles, and blue represents constrained edges.

![Constraint Benchmark](Documentation~/benchmark-constraint.png)

Furthermore, we present a performance comparison (with Burst enabled) between `v1.0.0` and `v2.0.0` for the refinement task.

![Refinement Benchmark](Documentation~/benchmark-refinement.png)
Expand All @@ -399,10 +405,11 @@ Furthermore, we present a performance comparison (with Burst enabled) between `v
## Roadmap v3.0

- [X] ~~Adapt Delaunay triangluation to `halfedges` approach.~~
- [ ] Remove super-triangle approach.
- [ ] Adapt constraints and refinement algorithm to `halfedges` approach.
- [ ] Improve performance of the constraint algorithm.
- [X] ~~Adapt constrained triangulation to `halfedges` approach.~~
- [X] ~~Improve performance of the constraint algorithm.~~
- [ ] Adapt refinement algorithm to `halfedges` approach.
- [ ] Improve performance of the refinement algorithm.
- [ ] Remove super-triangle approach.

## Bibliography

Expand Down
Loading