Export checkpoint! and rewind! for Manual Pool Management
#3
Conversation
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
Enable manual pool management by exporting checkpoint!/rewind! functions and adding direct TypedPool access methods. Changes: - Export checkpoint! and rewind! in public API - Add checkpoint!(tp::TypedPool) and rewind!(tp::TypedPool) for low-level access - Refactor type-specific methods to delegate to TypedPool methods (DRY principle) - Add comprehensive tests for TypedPool direct usage and delegation This allows users to manually manage pool state without importing, while maintaining clean implementation through method delegation. Generic no-arg methods were intentionally omitted to avoid namespace pollution. Related: #feat/cache_nd_view
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3 +/- ##
==========================================
+ Coverage 95.63% 95.65% +0.02%
==========================================
Files 6 6
Lines 412 414 +2
==========================================
+ Hits 394 396 +2
Misses 18 18 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR exports checkpoint! and rewind! functions to make them part of the public API and adds direct TypedPool access methods for advanced manual pool state management. The changes support both high-level pool management and low-level, performance-critical scenarios where users have direct TypedPool references.
- Exports
checkpoint!andrewind!(previously required explicit import) - Adds new
checkpoint!(tp::TypedPool)andrewind!(tp::TypedPool)methods for direct TypedPool access - Refactors type-specific methods to delegate to TypedPool methods, following DRY principle
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/AdaptiveArrayPools.jl | Exports checkpoint! and rewind! functions, removing prior comment about minimal API |
| src/core.jl | Adds TypedPool-specific checkpoint/rewind methods with documentation and refactors existing type-specific methods to delegate |
| test/test_state.jl | Adds comprehensive tests for direct TypedPool checkpoint/rewind functionality, nested state management, and delegation verification |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Update checkpoint!(tp::TypedPool) and rewind!(tp::TypedPool) docstrings to clearly mark them as internal implementation details and guide users to the public checkpoint!(pool, Type) API instead. This resolves documentation confusion where users might try to use get_typed_pool! (which requires explicit import) instead of the exported type-specific checkpoint!/rewind! methods. Changes: - Add "Internal API" warning admonition to TypedPool method docs - Replace get_typed_pool! example with public API recommendation - Remove get_typed_pool! from "See also" references - Guide users to checkpoint!(pool, Type) for manual management
Collaborator
Author
UpdateThe following is the correct pattern using public APIs: using AdaptiveArrayPools
# Public API - no import needed
pool = AdaptiveArrayPool()
checkpoint!(pool)
# ... work ...
rewind!(pool)
# Type-specific (less overhead, only for specific types)
checkpoint!(pool, Float64)
# ... work ...
rewind!(pool, Float64) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
Exports
checkpoint!/rewind!functions and adds directTypedPoolaccess for users who need manual pool state management.Changes
checkpoint!andrewind!are now part of the public APITypedPoolaccess viacheckpoint!(tp::TypedPool)andrewind!(tp::TypedPool)TypedPoolmethods (DRY principle)Usage
Design Decisions
checkpoint!()/rewind!()omitted to avoid namespace pollutionTesting
All 435 tests pass, including 12 new tests for: