All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.
The public API of this library consists of the functions declared in file h3api.h.in.
compact
detects and fails on cases with duplicated input indexes. (#299)
h3IsValid
returns false for indexes that have non-zero reserved bits. (#300)h3IsValid
andh3UnidirectionalEdgeIsValid
return false for indexes with the high bit set. (#300)
- Revert new
polyfill
algorithm until reported issues are fixed. (#293)
compact
handles zero length input correctly. (#278)bboxHexRadius
scaling factor adjusted to guarantee containment forpolyfill
. (#279)polyfill
new algorithm for up to 3x perf boost. (#282)- Fix CMake targets for KML generation. (#285)
h3ToCenterChild
function to find center child at given resolution (#267)getPentagonIndexes
(andpentagonIndexCount
) function to find pentagons at given resolution (#267)
- Fix bounds check for local IJ coordinates (#271)
- CMake options for excluding filter applications or benchmarks from the build. (#247)
h3GetFaces
function to find icosahedron faces for an index, and helper functionmaxFaceCount
(#253)
- Argument parsing for all filter applications is more flexible. (#238)
- Fix printing program name in
h3ToHier
error messages. (#254)
- Local coordinate spaces cannot cross more than one icosahedron edge. (#234)
- All dynamic internal memory allocations happen on the heap instead of the stack. (#235)
- Argument parsing for
h3ToGeo
,geoToH3
, andh3ToGeoBoundary
is more flexible. (#227)
localIjToH3
filter application (#222)- An option to print distances in the
kRing
filter application (#222)
- Arguments parsing for
kRing
filter application is more flexible. (#224)
benchmarkPolyfill
allocates its memory on the heap (#198)- Fixed constraints of vertex longitudes (#213)
- Zero only input to
uncompact
does not produce an error (#223)
binding-functions
build target generates an ASCII file on Windows (#193)
binding-functions
build target fixed when running the build out of source (#188)
getRes0Indexes
function for getting all base cells, and helper functionres0IndexCount
(#174)- Include defined constants for current library version (#173)
h3Line
andh3LineSize
functions for getting the line of indexes between some start and end (inclusive) (#165)
- Indexes in deleted pentagon subsequences are not considered valid.
experimentalH3ToLocalIj
function for getting local coordinates for an index. (#102)experimentalLocalIjToH3
function for getting an index from local coordinates. (#102)- Benchmarks for the kRing method for k's of size 10, 20, 30, and 40. (#142, #144)
- Internal
h3ToIjk
function renamed toh3ToLocalIjk
. (#102) h3ToIjk
filter application replaced withh3ToLocalIj
. (#102)
- Added
#include <stdio.h>
tobenchmark.h
(#142)
- Fixed bounding box bug for polygons crossing the antimeridian (#130)
- Normalize output of h3SetToMultiPolygon to align with the GeoJSON spec, ensuring that each polygon has only one outer loop, followed by holes (#131)
- Longitude outputs are now guaranteed to be in the range [-Pi, Pi]. (#93)
- Implemented closed form formula for maxKringSize. Source: https://oeis.org/A003215 (#138)
- Improved test and benchmark harnesses (#126, #128)
h3Distance
function for determining the grid distance between H3 indexes (#83)- Internal
h3ToIjk
function for getting IJK+ coordinates from an index (#83) - Internal
ijkDistance
function for determining the grid distance between IJK+ coordinates (#83) h3ToIjk
filter application for experimenting withh3ToIjk
(#83)
- Don't require a C++ compiler (#107)
- Most dynamic internal memory allocations happen on the heap instead of the stack (#100)
- Added Direction enum, replacing int and defined constants (#77)
- Ensured unused memory is cleared for pentagon children. (#84)
- Fixed compiler warnings in
h3ToGeoHier
andh3ToGeoBoundaryHier
. (#90) - Fixed a segfault in
h3SetToLinkedGeo
(#94)
- Warnings are not errors by default. (#90)
- Generator for the faceCenterPoint table (#67)
- Generator for number of indexes per resolution (#69)
- Added CMake
WARNINGS_AS_ERRORS
option, default on, for Clang and GCC (#70) - Added CMake
TEST_WRAPPER
setting whenWRAP_VALGRIND
is on (#66)
- Moved Vec3d structure to
vec3d.h
(#67) - Added input validation when getting the origin or destination of an edge (#74)
- Changed signature of internal function h3NeighborRotations.
- Do not require support for
hexRange
,hexRanges
, orhexRangeDistances
in the bindings. These functions may be deprecated in the public API in future releases; consumers should usekRing
andkRingDistances
instead. - Performance improvement in core indexing logic for
geoToH3
(thanks @wewei!)
- Fixed duplicate vertex in h3ToGeoBoundary for certain class III hexagons (#46)
- Release guide
- Assertions when allocating memory on the heap.
- Most internal memory allocations happen on the stack instead of the heap.
- CMake config installation to ease use of h3 from CMake projects.
- Add CMake toolchain file to set build options upfront.
- Add CMake
C_CLANG_TIDY
property to integrate clang-tidy checks during build. - YouCompleteMe completion support.
- Improved resilience to out of range inputs.
- Minimum CMake version to 3.1.
- Set
CMAKE_C_STANDARD
to11
instead of using compiler flag-std=c1x
. - Use
CMAKE_POSITION_INDEPENDENT_CODE
instead of using compiler flag-fPIC
. - Rename library target from
h3.1
toh3
withSONAME
property of 1.
- CMake
H3_COMPILER
option in favor of built-inCMAKE_C_COMPILER
. - CMake
BUILD_STATIC
option in favor of built-inBUILD_SHARED_LIBS
. - CMake
ENABLE_TESTS
option in favor of built-inBUILD_TESTING
. - File globbing in CMake in favor of listing source files.
- Removed the
H3IndexFat
internal structure.
- Simplified build process on Windows.
- Fixed an issue where tests would fail on ARM systems.
- Added a
make install
target.
- Improved compatability with building on Windows.
- Fixed various cases where the test suite could crash or not compile.
- First public release.