The following static helpers return an h3indexset (or intset for h3GetIcosahedronFaces) — the finite-collection companion type of h3index. They operate on a static h3index (or an h3indexset) and are not lifted to th3index; the temporal lift is deferred pending a tset<T> primitive.
All cells within k grid steps of the origin (inclusive of the origin at k=0).
h3GridDisk(h3index, integer) → h3indexset
The cells at exactly k grid steps from the origin. Fails near pentagons.
h3GridRing(h3index, integer) → h3indexset
The inclusive path of cells between two cells of the same resolution.
h3GridPathCells(h3index, h3index) → h3indexset
All children of a cell at the given target resolution.
h3CellToChildren(h3index, integer) → h3indexset
Compacted representation of a cell set — finer cells are merged into their parent whenever a full hexagonal set of siblings is present.
h3CompactCells(h3indexset) → h3indexset
Uncompacted representation at the given resolution — the inverse of h3CompactCells.
h3UncompactCells(h3indexset, integer) → h3indexset
All outgoing directed edges of a cell (6 for hexagons, 5 for pentagons).
h3OriginToDirectedEdges(h3index) → h3indexset
All vertexes of a cell (6 for hexagons, 5 for pentagons).
h3CellToVertexes(h3index) → h3indexset
The icosahedron face indexes (0..19) intersected by a cell.
h3GetIcosahedronFaces(h3index) → intset