Directed Edges

Functions for working with directed edges between neighboring H3 cells.

Corresponds to the H3 C API Directed Edges section.

cellsToDirectedEdge(origin::H3Index, destination::H3Index) -> (H3Error, H3Index)

Create a directed edge H3 index from an origin cell to a neighboring destination cell.

See also the H3 C API: cellsToDirectedEdge

isValidDirectedEdge(edge::H3Index) -> Bool

Check whether an H3 index represents a valid directed edge.

See also the H3 C API: isValidDirectedEdge

getDirectedEdgeOrigin(edge::H3Index) -> (H3Error, H3Index)

Get the origin cell of a directed edge.

getDirectedEdgeDestination(edge::H3Index) -> (H3Error, H3Index)

Get the destination cell of a directed edge by finding the neighbor of the origin in the encoded direction.

directedEdgeToCells(edge::H3Index) -> (H3Error, H3Index, H3Index)

Get both the origin and destination cells of a directed edge.

See also the H3 C API: directedEdgeToCells

originToDirectedEdges(op::F, origin::H3Index) -> H3Error where {F}

Call op(edge) for each directed edge originating from the cell (no result vector allocated).

originToDirectedEdges(origin::H3Index) -> (H3Error, Vector{H3Index})

Get all directed edges originating from a cell (6 for hexagons, 5 for pentagons).

directedEdgeToBoundary(edge::H3Index) -> (H3Error, CellBoundary)

Get the boundary vertices shared between the origin and destination cells of a directed edge.

reverseDirectedEdge(edge::H3Index) -> (H3Error, H3Index)

Get the directed edge in the reverse direction (swapping origin and destination).