# H3 Index Representations

## #

IntroductionThe H3 system assigns a unique hierarchical index to each cell. The H3 index of a resolution *r* cell begins with the appropriate resolution 0 base cell number. This is followed by a sequence of *r* digits 0-6, where each *i*^{th} digit *d*_{i} specifies one of the 7 cells centered on the cell indicated by the coarser resolution digits *d*_{1} through *d*_{i-1}. A local hexagon coordinate system is assigned to each of the resolution 0 base cells and is used to orient all hierarchical indexing child cells of that base cell. The assignment of digits 0-6 at each resolution uses a *Central Place Indexing* arrangement (see Sahr, 2014). In the case of the 12 pentagonal cells the indexing hierarchy produced by sub-digit 1 is removed at all resolutions.

Child hexagons are linearly smaller than their parent hexagons.

## #

H3Index RepresentationAn `H3Index`

is the integer representation of an H3 index, which may be one of multiple modes to indicate the concept being indexed.

- Mode 0 is reserved and indicates an invalid H3 index.
- Mode 1 is an
*H3 Cell*(Hexagon/Pentagon) index. - Mode 2 is an
*H3 Unidirectional Edge*(Cell A -> Cell B) index. - Mode 3 is planned to be a bidirectional edge (Cell A <-> Cell B).
- Mode 4 is an
*H3 Vertex*(i.e. a single vertex of an H3 Cell).

The canonical string representation of an `H3Index`

is the hexadecimal representation of the integer, using lowercase letters. The string representation is variable length (no zero padding) and is not prefixed or suffixed.

### #

Invalid IndexMode 0 contains a special index, `H3_NULL`

, which is unique: it is bit-equivalent to `0`

.
This index indicates, *specifically*, an invalid, missing, or uninitialized H3 index;
it is analogous to `NaN`

in floating point.
It should be used instead of an arbitrary Mode 0 index, due to its uniqueness and easy identifiability.

### #

H3 Cell IndexAn H3 Cell index (mode 1) represents a cell (hexagon or pentagon) in the H3 grid system at a particular resolution. The components of the H3 Cell index are packed into a 64-bit integer in order, highest bit first, as follows:

- 1 bit reserved and set to 0,
- 4 bits to indicate the H3 Cell index mode,
- 3 bits reserved and set to 0,
- 4 bits to indicate the cell resolution 0-15,
- 7 bits to indicate the base cell 0-121,
- 3 bits to indicate each subsequent digit 0-6 from resolution 1 up to the resolution of the cell (45 bits total are reserved for resolutions 1-15)

The three bits for each unused digit are set to 7.

### #

H3 Unidirectional Edge IndexAn H3 Undirectional Edge index (mode 2) represents a single directed edge between two cells (an "origin" cell and a neighboring "destination" cell). The components of the H3 Unidirectional Edge index are packed into a 64-bit integer in order, highest bit first, as follows:

- 1 bit reserved and set to 0,
- 4 bits to indicate the H3 Unidirectional Edge index mode,
- 3 bits to indicate the edge (1-6) of the origin cell,
- Subsequent bits matching the index bits of the origin cell.

### #

H3 Vertex IndexAn H3 Vertex index (mode 4) represents a single topological vertex in H3 grid system, shared by three cells. Note that this does not include the distortion vertexes occasionally present in a cell's geo boundary. An H3 Vertex is arbitrarily assigned one of the three neighboring cells as its "owner", which is used to calculate the canonical index and geo coordinate for the vertex. The components of the H3 Vertex index are packed into a 64-bit integer in order, highest bit first, as follows:

- 1 bit reserved and set to 0,
- 4 bits to indicate the H3 Vertex index mode,
- 3 bits to indicate the vertex number (0-5) of vertex on the owner cell,
- Subsequent bits matching the index bits of the owner cell.

## #

Bit layout of H3IndexThe layout of an `H3Index`

is shown below in table form. The interpretation of the "Reserved" field differs depending on the mode of the index.

0x0F | 0x0E | 0x0D | 0x0C | 0x0B | 0x0A | 0x09 | 0x08 | 0x07 | 0x06 | 0x05 | 0x04 | 0x03 | 0x02 | 0x01 | 0x00 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|

0x30 | Reserved | Mode | Mode-Dependent | Resolution | Base cell | |||||||||||

0x20 | Base cell | Digit 1 | Digit 2 | Digit 3 | Digit 4 | Digit 5 | ||||||||||

0x10 | Digit 5 | Digit 6 | Digit 7 | Digit 8 | Digit 9 | Digit 10 | ||||||||||

0x00 | Digit 10 | Digit 11 | Digit 12 | Digit 13 | Digit 14 | Digit 15 |

## #

Links- Observable notebook example: H3 Index Bit Layout
- Observable notebook example: H3 Index Inspector