Improve description of structure Simd::Rectangle - #1009
Merged
Merged
Conversation
Document Simd::Rectangle from real usage in views, drawing, motion, detection, contours and shift detection: the half-open range [left, right) x [top, bottom), rounding of floating sides to ptrdiff_t, and the difference between union, intersection, side addition and shift. Co-authored-by: igor.ermolaev <igor.ermolaev@altezza.org>
ermig1979
marked this pull request as ready for review
September 23, 2026 10:06
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documentation-only update of
Simd::Rectangle, written from how the type is used in views, drawing, motion, detection, contours and shift detection.[left, right) x [top, bottom)in image coordinates (origin at the top-left, X to the right, Y downward).Rectangle(view.Size())is the whole image. Floating sides converted toptrdiff_tround to the nearest integer, halves away from zero.operator |=is the bounding union (a point grows the box by one pixel).operator &=andIntersectionclip.operator +=,operator +,operator *andoperator /combine or scale the four sides.Shiftwrites a translation;Shiftedreturns one.cv::Rectstays(x, y, width, height)on conversion.docs/2026.htmlrecord the documentation change.Code changes are limited to comments in
src/Simd/SimdRectangle.hppand that release-note line. The rectangle implementation is unchanged.