Add error returns to gridPath/gridDistance functions #507
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
dfellis
approved these changes
Aug 26, 2021
nrabinowitz
approved these changes
Aug 26, 2021
| @@ -141,11 +141,11 @@ int h3ToLocalIjk(H3Index origin, H3Index h3, CoordIJK *out) { | |||
| if (originBaseCell < 0 || // LCOV_EXCL_BR_LINE | |||
| originBaseCell >= NUM_BASE_CELLS) { | |||
| // Base cells less than zero can not be represented in an index | |||
| return 1; | |||
| return E_CELL_INVALID; | |||
There was a problem hiding this comment.
Not seeing any tests for this specific error, could we add?
There was a problem hiding this comment.
Changed/added tests for specific error codes
| int res = H3_GET_RESOLUTION(origin); | ||
| int originBaseCell = H3_GET_BASE_CELL(origin); | ||
| if (originBaseCell < 0 || // LCOV_EXCL_BR_LINE | ||
| originBaseCell >= NUM_BASE_CELLS) { | ||
| // Base cells less than zero can not be represented in an index | ||
| return 1; | ||
| return E_CELL_INVALID; |
There was a problem hiding this comment.
Ditto, not seeing specific tests for this
| @@ -457,12 +457,12 @@ int localIjkToH3(H3Index origin, const CoordIJK *ijk, H3Index *out) { | |||
| // accounted for here - instead just fail if the recovered index is | |||
| // invalid. | |||
| if (_h3LeadingNonZeroDigit(*out) == K_AXES_DIGIT) { | |||
| return 4; | |||
| return E_PENTAGON; | |||
There was a problem hiding this comment.
Curious why this and the errors above had different codes previously, but now both get E_PENTAGON?
There was a problem hiding this comment.
These codes were arbitrary and just indicated different return sites - they didn't really have any smenatic meaning. In h3-java, 3, 4, and 5 were all translated to the same message (essentially E_PENTAGON)
isaacbrodsky
force-pushed
the
error-returns-grid-path
branch
from
00749d8 to
a502769
Compare
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.
Adds consistent error returns to the gridPathCells, gridDistance, and localIj series of functions. These functions mostly already had error codes but they were not consistent with
H3Error.Changes to traversal.mdx might need to be rebased with #505.
I'm moving functions to pass int64_t when it refers to a number of cells to be consistent with
getNumCells. Would it make sense to introduce a typedef (H3NumCells?H3NumIndexes?) to avoid confusion about which type to use? Or just standardize on int64_t and let ourselves get used to that?