Inspection

Functions for examining properties of H3 indexes.

Corresponds to the H3 C API Inspection section.

Index Properties

FastH3.getResolution — Function

getResolution(h::H3Index) -> Int

Get the resolution of an H3 index.

See also the H3 C API: getResolution

FastH3.getBaseCellNumber — Function

getBaseCellNumber(h::H3Index) -> Int

Get the base cell number (0–121) of an H3 index.

See also the H3 C API: getBaseCellNumber

FastH3.isValidCell — Function

isValidCell(h::H3Index) -> Bool

Check whether an H3 index represents a valid cell.

See also the H3 C API: isValidCell

FastH3.isValidIndex — Function

isValidIndex(h::H3Index) -> Bool

Check whether an H3 index is valid (cell, directed edge, or vertex).

See also the H3 C API: isValidIndex

FastH3.isPentagon — Function

isPentagon(h::H3Index) -> Bool

Check whether an H3 index represents a pentagon cell.

See also the H3 C API: isPentagon

FastH3.isResClassIII — Function

isResClassIII(h::H3Index) -> Bool

Check whether the resolution of an H3 index is Class III.

See also the H3 C API: isResClassIII

FastH3.maxFaceCount — Function

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

Get the maximum number of icosahedron faces a cell may intersect.

See also the H3 C API: maxFaceCount

FastH3.getIcosahedronFaces — Function

getIcosahedronFaces(op::F, h::H3Index) -> H3Error where {F}

Call op(face) for each assigned icosahedron face index (omits internal INVALID_FACE slots; order matches increasing slot index among valid faces). For the fixed-length Vector{Int} buffer including sentinel slots, use the getIcosahedronFaces(h) overload.

See also the H3 C API: getIcosahedronFaces

getIcosahedronFaces(h::H3Index) -> Tuple{H3Error, Vector{Int}}

Get all icosahedron faces intersected by a cell.

See also the H3 C API: getIcosahedronFaces

String Conversion

FastH3.stringToH3 — Function

stringToH3(str::AbstractString) -> Tuple{H3Error, H3Index}

Parse a hexadecimal string to an H3 index.

See also the H3 C API: stringToH3

FastH3.h3ToString — Function

h3ToString(h::H3Index) -> String

Convert an H3 index to its hexadecimal string representation.

See also the H3 C API: h3ToString

Error Descriptions

FastH3.describeH3Error — Function

describeH3Error(err::H3Error) -> String

Return a human-readable description of an H3Error code.

See also the H3 C API: describeH3Error

Types

FastH3.H3Index — Type

64-bit H3 index. Alias for UInt64. Encodes cell, directed edge, or vertex identifiers in the H3 system.

FastH3.H3_NULL — Constant

The null/invalid H3 index (all bits zero).

FastH3.H3Error — Type

Error codes returned by H3 operations. See also: describeH3Error.

FastH3.LatLng — Type

Latitude/longitude coordinate pair in radians.

FastH3.CellBoundary — Type

Cell boundary represented as a fixed-capacity array of LatLng vertices.

FastH3.CoordIJ — Type

IJ coordinate pair used for local grid coordinates. See the H3 C API: CoordIJ.

FastH3.GeoLoop — Type

Ordered sequence of LatLng vertices forming a closed loop.

FastH3.GeoPolygon — Type

Polygon defined by an outer GeoLoop and zero or more holes.

FastH3.ContainmentMode — Type

Mode for polygon containment checks.