Feature: clear unused memory for pentagon children #84
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
|
|
8000
src/h3lib/lib/h3Index.c
Outdated
| @@ -194,6 +194,8 @@ void H3_EXPORT(h3ToChildren)(H3Index h, int childRes, H3Index* children) { | |||
| for (int i = 0; i < 7; i++) { | |||
| if (!isAPentagon || i != K_AXES_DIGIT) { | |||
| H3_EXPORT(h3ToChildren)(makeDirectChild(h, i), childRes, children); | |||
| } else { | |||
| *children = H3_INVALID_INDEX; | |||
There was a problem hiding this comment.
I'm not sure this will zero enough of the buffer, since the recursive call to h3ToChildren could have generated more than one index. I think it needs to zero out bufferChildStep indexes.
Here is the test case I used:
TEST(pentagonChildrenMultires) {
H3Index pentagon;
setH3Index(&pentagon, 1, 4, 0);
const int expectedCount = (5 * 7) + (6);
const int paddedCount = H3_EXPORT(maxH3ToChildrenSize)(pentagon, 3);
H3Index* children = calloc(paddedCount, sizeof(H3Index));
H3_EXPORT(h3ToChildren)(sfHex8, 10, children);
H3_EXPORT(h3ToChildren)(pentagon, 3, children);
// just for testing:
for (int i = 0; i < paddedCount; i++) {
printf("test: %llx\n", children[i]);
}
verifyCountAndUniqueness(children, paddedCount, expectedCount);
free(children);
}
|
Thanks! I've updated the PR accordingly. |
jogly
approved these changes
Jun 27, 2018
jogly
reviewed
Jun 27, 2018
CHANGELOG.md
Outdated
| @@ -8,6 +8,7 @@ The public API of this library consists of the functions declared in file | |||
| ## [Unreleased] | |||
| ### Added | |||
| - Added Direction enum, replacing int and defined constants (#77) | |||
| - Ensured unused memory is cleared for pentagon children. | |||
There was a problem hiding this comment.
tiny nit: i'd put this under Fixed instead of Added
isaacbrodsky
approved these changes
Jun 27, 2018
mrdvt92
pushed a commit
to mrdvt92/h3
that referenced
this pull request
Jun 19, 2022
Feature: clear unused memory for pentagon children
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.
This is a fantastic library!
I've encountered an inconsistency between
h3ToChildrenandkRing: The later sets memory to zero for pentagons. This left me confused when usingh3ToChildrenon pentagons which in my case returned valid indices (left over in memory from other calls) for the children that are skipped.This pull request zeroes out memory for the unused slots.
Alternatively, the difference should at least be documented to let us know to use calloc.