Internals

Non-exported functions that may be useful for advanced usage. Access these with the FastH3. module prefix.

Grid Traversal Helpers

FastH3.h3NeighborRotations — Function

h3NeighborRotations(origin::H3Index, dir::Direction, rotations::Int) -> (H3Error, H3Index, Int)

Compute the neighbor of origin in direction dir, applying rotations initial CCW 60° rotations. Returns the error code, the neighbor cell, and the updated rotation count.

Translated from C source: algos.c

source

FastH3.gridDiskDistancesSafe — Function

gridDiskDistancesSafe(origin::H3Index, k::Int) -> (H3Error, Vector{H3Index}, Vector{Int})

BFS-based safe implementation of gridDiskDistances that handles pentagons.

source

Index Helpers

FastH3.getIndexDigit — Function

getIndexDigit(h::H3Index, res::Int) -> Tuple{H3Error, Int}

Get the index digit at resolution res (1-indexed). Returns (error, digit).

source

FastH3.constructCell — Function

constructCell(res::Int, baseCellNumber::Int, digits::Vector{Int}) -> Tuple{H3Error, H3Index}

Construct an H3 cell index from resolution, base cell number, and digit array.

source