fix: checkMinOverlap() off-by-one at the exact minimum-overlap boundary - #59
Merged
Conversation
The function's own docs say it "checks if the overlap ... is at least a specified percentage," but the comparison used strict `>`: pass <- overlap_len > required_overlap So an overlap that exactly equals the required minimum (e.g. exactly 20% with the default min_overlap = 0.2) failed the check and threw/ warned "Minimum overlap condition not met," contradicting the documented "at least" semantics. Changed to `>=`, matching the doc. Not deprecated; this is a normal, actively-documented, exported function. Verified with x of length 10 and min_overlap = 0.2 (required overlap = exactly 2): - overlap == 2 (exact boundary): now passes (previously failed). - overlap == 1 (below boundary): still fails, unchanged. - overlap == 5 (above boundary): still passes, unchanged.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 221bad64cd
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
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.
What was the bug?
checkMinOverlap()'s own docs say it "checks if the overlap ... is at least a specified percentage" of the shorter vector — but the comparison used strict>:What was the impact?
An overlap that exactly equals the required minimum (e.g. exactly 20% with the default
min_overlap = 0.2) failed the check and triggeredstop()/warning()("Minimum overlap condition not met"), contradicting the documented "at least" semantics — a boundary-value bug that silently rejects valid input right at the threshold.The fix
Changed
>to>=, matching the documented behavior exactly. This function is not deprecated — it's a normal, actively-documented, exported function.Testing
With
xof length 10 andmin_overlap = 0.2(sorequired_overlap= exactly 2):overlap_len == 2(exact boundary): now passes — previously failed.overlap_len == 1(below boundary): still fails, unchanged.overlap_len == 5(above boundary): still passes, unchanged.R CMD build+R CMD check: no new NOTEs/WARNINGs/ERRORs vs. the currentdevbranch (the one remaining ERROR, a missing@exportonpU(), is pre-existing and already tracked separately).No
.Rd/NAMESPACEchange needed (roxygen block unchanged).No
testthat/automated tests added, per repo convention.Generated by Claude Code