uber / h3 / 18479241508

99%

push

github

Add isValidIndex function (#1056)

* Add isValidIndex function

Implement a general validation function that checks if an H3 index
is valid for any mode (cell, directed edge, or vertex).

Changes:
- Add isValidIndex() function declaration to h3api.h.in
- Implement isValidIndex() in h3Index.c
- Add includes for directedEdge.h and vertex.h in h3Index.c
- Add comprehensive test coverage in testH3Index.c

The function returns true if the index is valid as a cell, directed edge,
or vertex, providing a single validation function for any H3 index type.

Fixes #1043

* Fix neighbor retrieval in isValidIndex test

Replace incorrect neighbor++ with proper gridRingUnsafe call to get
an actual neighboring cell for directed edge testing. Simply incrementing
an H3Index will almost never produce a valid neighboring cell.

This addresses the review feedback from ajfriend on lines 224-227.

* Fix clang-format formatting in isValidIndex function

Apply clang-format style to match project formatting conventions:
- Put first two conditions on same line
- Wrap long comment to 80 characters

* Fix clang-format formatting in h3api.h.in header

Apply clang-format style to isValidIndex documentation comment:
- Wrap comment across 3 lines for proper formatting

1669 of 1699 branches covered (98.23%)

Branch coverage included in aggregate %.

3 of 3 new or added lines in 1 file covered. (100.0%)

2888 of 2907 relevant lines covered (99.35%)

37240870.55 hits per line