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.

Sign up for GitHub

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

Jump to bottom

feat!: rework clipline #16

Merged
merged 27 commits into from
Aug 11, 2024
Merged

feat!: rework clipline #16

merged 27 commits into from
Aug 11, 2024

Conversation

nxsaken
Copy link
Owner

@nxsaken nxsaken commented Aug 11, 2024

This is a complete rewrite of clipline.

Highlights

  • Introduces iterators for raw and clipped axis-aligned, diagonal and arbitrary line segments.
    • Provides specialized iterators for signed-axis-aligned, quadrant-covered and octant-covered line segments.
  • Introduces a new clipping algorithm, synthesizing the works of Sobkow-Pospisil-Yang (1987), Dörr (1990), and Kuzmin (1995).
  • Removes integer overflow and division by zero (closes Forbid arithmetic_side_effects #10).
    • Ensures iterators are defined on the whole numeric domain.
  • Adds support for unsigned coordinates (closes Support all integral numeric types #12).
  • Adds property tests (via proptest) ensuring clipped iterators produce the same points as raw iterators clipped naively.

@nxsaken
feat!: introduce a new implementation using const generics (sans clip…
d76ff13 
…ping)

Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
feat!: add diagonal iterators
bbeebd4 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
feat!: new clipping algorithm (special case)
4db3d25 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
ci: set up new CI workflow
6aa01a2 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
feat: implement clipping for all cases
1d08ce2 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
feat: add bresenham diagonals, fix diagonal clipping
c22a9b1 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
feat: support all integers except u64/i64 for Bresenham
2847b17 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
bench: compare new clipping algorithm with prev versions
e634683 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
refactor: earlier trivial rejects
20673a4 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
perf: inline math methods
8e5d84b 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
feat: use &Clip, restore bresenham diagonals
fd0b51d 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
bench: compare unclipped lines
298e723 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
fix: correct boundary in axis-aligned clipping
8a3a7dc 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
feat: gate Bresenham<int64> behind bresenham_64, add compile-time…
0938518 
… tests

Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
refactor: swap const generics in SignedAxisAligned iterators
64733f6 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
feat!: rename types for consistency, add documentation
2376c49 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
fix: use correct comparisons in trivial rejects
a032ce3 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
fix: ensure clipped octants match unclipped versions
404194f 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
test: add clipping proptests for AnyOctant
d1b7089 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
docs: fix some docs
640e41b 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
bench: remove benchmark
7c97684 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
test: add small clipping window cases
7d06a3c 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
chore: ignore .DS_Store
667f4db 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
docs: update CI badge
c9adc03 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
fix: gate math_impl for 64-bit integers
3b85394 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
fix(clippy): allow unreachable_patterns in size_hint
1442d3f 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken
test: remove test example
5a31121 
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken nxsaken merged commit d42cde7 into main Aug 11, 2024
12 checks passed
@nxsaken nxsaken deleted the feat/rework branch August 12, 2024 07:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Support all integral numeric types Forbid arithmetic_side_effects
1 participant
@nxsaken