Add BoundaryIter host coverage

[psychocoderHPC]

Split from local commit 5a8d8b1.

Base branch: dev.

Summary by CodeRabbit

Release Notes

• New Features

  • Added out-of-bounds detection to boundary directions for improved classification accuracy.

• Bug Fixes

  • Enhanced boundary classification methods to correctly exclude out-of-bounds regions from vertex, edge, face, and cell categorization.

• Tests

  • Added comprehensive unit tests for boundary iterator functionality, validating enumeration order, classification accuracy, and output stability.

[coderabbitai]

Warning

Rate limit exceeded

@psychocoderHPC has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 9 minutes and 27 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 9 minutes and 27 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: e5e35694-211b-438f-b0ee-db767e83841a

📥 Commits

Reviewing files that changed from the base of the PR and between f322ff2 and dde8c1a.

📒 Files selected for processing (2)

• include/alpaka/mem/BoundaryIter.hpp
• test/unit/mem/boundaryIter.cpp

📝 Walkthrough

Walkthrough

The changes add an out-of-bounds detection mechanism to Alpaka's boundary direction classification system. A new isOutOfBounds() method is introduced and integrated into all existing dimensionality classification methods (isVertex, isEdge, isFace, isCell, isInterior) to exclude any boundary directions containing OOB components. Comprehensive unit tests validate the new behavior.

Changes

Cohort / File(s)	Summary
BoundaryIter Logic Enhancement include/alpaka/mem/BoundaryIter.hpp	Added isOutOfBounds() method that detects BoundaryType::OOB components. Updated five classification methods (isVertex(), isEdge(), isFace(), isCell(), isInterior()) to require !isOutOfBounds() alongside existing dimensionality checks, preventing out-of-bounds directions from matching any classification.
BoundaryIter Tests test/unit/mem/boundaryIter.cpp	New comprehensive test suite verifying boundary direction iterator enumeration order, classification helper correctness for various boundary patterns, OOB sentinel behavior, core boundary direction creation with halo preservation, factory overload behavior, and stream output stability.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 With boundaries now doubly sure,
OOB checks make logic pure,
Classification stays refined—
No mixed edges left behind,
Tested well, the code's aligned! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 75.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Add BoundaryIter host coverage' accurately describes the main change: adding unit tests and host-side coverage for the BoundaryIter functionality, along with supporting API enhancements.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch pr-add-boundaryiter-host-coverage

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[psychocoderHPC]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

🧹 Nitpick comments (1)

test/unit/mem/boundaryIter.cpp (1)

19-50: Tighten the lexicographic-order claim or add explicit order assertions.

The section comment says lexicographic order is verified, but the test currently checks uniqueness/count/first/end only. Either add order checks for the traversal sequence or soften the comment to match what is asserted.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@test/unit/mem/boundaryIter.cpp` around lines 19 - 50, The test comment claims
lexicographic order but the loop only asserts uniqueness and first element;
update the test to explicitly assert order by constructing the expected
lexicographic sequence of BoundaryDirections and comparing it to visited (e.g.
generate expected by iterating the 3^dim combinations in lexicographic order or
build expected vector using alpaka::BoundaryType::LOWER/UPPER/MIDDLE) or
alternatively change the comment to remove the "lexicographic order" claim;
modify the code around directions, visited, and the REQUIRE checks so they
either compare visited == expected or the comment matches the actual checks.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@test/unit/mem/boundaryIter.cpp`:
- Around line 19-50: The test comment claims lexicographic order but the loop
only asserts uniqueness and first element; update the test to explicitly assert
order by constructing the expected lexicographic sequence of BoundaryDirections
and comparing it to visited (e.g. generate expected by iterating the 3^dim
combinations in lexicographic order or build expected vector using
alpaka::BoundaryType::LOWER/UPPER/MIDDLE) or alternatively change the comment to
remove the "lexicographic order" claim; modify the code around directions,
visited, and the REQUIRE checks so they either compare visited == expected or
the comment matches the actual checks.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 7aa29dde-5879-403d-a7ad-1bb0df671876

📥 Commits

Reviewing files that changed from the base of the PR and between 0750ba2 and f322ff2.

📒 Files selected for processing (2)

• include/alpaka/mem/BoundaryIter.hpp
• test/unit/mem/boundaryIter.cpp

[psychocoderHPC]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.