[][src]Crate libh3

Structs

GeoCoord

Represent a coordinate

Functions

degs_to_rads

Convert degrees to radians

edge_length_km

Return the edge length of a hexagon at a particular resolution in kilometers.

edge_length_m

Return the edge length of a hexagon at a particular resolution in meters.

geo_to_h3

Convert a GeoCoord to a H3 index.

get_res_0_indexes

All the resolution 0 H3 indexes.

h3_to_geo

Convert a H3 index value to a GeoCoord

h3_to_geo_boundary

Convert a H3 index value to a GeoBoundary which are a vector of points that describe a H3 Index's boundary

h3_get_resolution

Return the resolution of a H3 index

h3_is_valid

Determine if H3 index is valid

h3_indexes_are_neighbors

Determine if two H3 indexes are neighbors

h3_is_pentagon

Determine if the specified H3 index is a pentagon.

h3_get_base_cell

Get the number of the base cell for a given H3 index

h3_distance

Get the grid distance between two hex indexes. This function may fail to find the distance between two indexes if they are very far apart or on opposite sides of a pentagon.

h3_to_parent

Returns the parent (coarser) index containing h3.

h3_to_children

Returns children indexes contained by the given index at the given resolution.

hex_area_km_2

Determine the area of a hexagon at a particular resolution.

hex_range
hex_range_distances
k_ring

Get all hexagons in a k-ring around a given center. The order of the hexagons is undefined.

k_ring_distances

Get all hexagons in a k-ring around a given center, in an array of arrays ordered by distance from the origin. The order of the hexagons within each ring is undefined.

max_h3_to_children_size

Returns the size of the array needed by h3ToChildren for these inputs.

num_hexagons

Return the number of hexagons at a particular resolution.

polyfill

Get all hexagons with centers contained in a given polygon. The polygon is specified with GeoJson semantics as an array of loops. The first loop is the perimeter of the polygon, and subsequent loops are expected to be holes.

rads_to_degs

Convert radians to degrees

res_0_index_count

Number of resolution 0 H3 indexes.

Type Definitions

H3Index

A H3 index value a unique address of a hexagon or more unlikely a pentagon.

Resolution

A resolution that ranges from 0 to 15.