Improve consistency in the C++ interface #653
Merged
Conversation
This file contains 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
These changes aim to improve the consistency of the C++ API between the 32-bit version and the 64-bit version. Details: - Rename `RoaringSetBitForwardIterator` to `RoaringSetBitBiDirectionalIterator` (the old one is now deprecated). - Add methods: `Roaring::clear` `Roaring::isFull` `Roaring::containsRangeClosed`. - Revise `move_equalorlarger` methods in iterators. - Add `api::roaring_bitmap_flip_inplace_closed` method. - Add `api::roaring_bitmap_contains_range_closed` method. - Add `api::roaring_bitmap_flip_closed` method. - Other minor changes.
lemire
reviewed
Aug 20, 2024
lemire
reviewed
Aug 20, 2024
lemire
reviewed
Aug 20, 2024
lemire
reviewed
Aug 20, 2024
lemire
reviewed
Aug 20, 2024
lemire
reviewed
Aug 20, 2024
|
Looks good to me. I invited others to comment. Let us keep the breaking changes to a minimum. Deprecation is fine. |
Main changes: - Add the `api::roaring_bitmap_range_cardinality_closed` method. - Add boundary checks for methods: `api::roaring_bitmap_add_range` `api::roaring_bitmap_remove_range`.
mapleFU
reviewed
Aug 21, 2024
| class RoaringSetBitBiDirectionalIterator; | ||
|
|
||
| /** DEPRECATED, use `RoaringSetBitBiDirectionalIterator`. */ | ||
| using RoaringSetBitForwardIterator = RoaringSetBitBiDirectionalIterator; |
There was a problem hiding this comment.
Can we use CROARING_DEPRECATED?
There was a problem hiding this comment.
I'd like to, but:
- currently, the
Roaring64MapSetBitForwardIteratoris not marked as deprecated. CROARING_DEPRECATEDexpands to__attribute__((deprecated))for GNUC and Clang, sousing xxx CROARING_DEPRECATED = xxx;works. However, for MSVC, it expands to__declspec(deprecated), which won't work in this format.
SLieve
reviewed
Aug 29, 2024
SLieve
approved these changes
Aug 29, 2024
|
Running tests with the latest changes. |
|
Merging. |
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.
These changes aim to improve the consistency of the C++ API between the 32-bit version and the 64-bit version.
Related issues: #629
Changes:
RoaringSetBitForwardIteratortoRoaringSetBitBiDirectionalIterator(the old one is now deprecated).Roaring::clearRoaring::isFullRoaring::containsRangeClosed.move_equalorlargermethods in iterators.api::roaring_bitmap_flip_inplace_closedmethod.api::roaring_bitmap_contains_range_closedmethod.api::roaring_bitmap_flip_closedmethod.api::roaring_bitmap_range_cardinality_closedmethod.If merged, only the following methods remain that are only implemented in the 32-bit version(in class
Roaring) but not in the 64-bit version(in classRoaring64Map):containsRangerangeUint64Arrayand_cardinalityor_cardinalityandnot_cardinalityxor_cardinalityjaccard_indexrank_manyAlso, the methods mentioned in #549 need to be further implemented.