| Overview |  |
coord() = {float(), float()}
h3index() = non_neg_integer()
resolution() = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15
| children/2 | Returns the children container by the given Index at the given child resolution ChildRes. |
| compact/1 | Compacts the given list of indexes as best as possible. |
| edge_length_kilometers/1 | |
| edge_length_meters/1 | |
| from_geo/2 | Indexes the location at the specified resolution. |
| from_string/1 | Converts the string representation to an index. |
| get_base_cell/1 | Returns the base cell number of the index. |
| get_resolution/1 | Returns the resolution of the index. |
| get_unidirectional_edge/2 | Returns a unidirectiol edge based on the given origin and destination. |
| grid_distance/2 | Returns the distance in grid cells between the two indexes. |
| hex_area_km2/1 | |
| hex_area_m2/1 | |
| indices_are_neighbors/2 | |
| is_class3/1 | Returns whether the given index has a resolution with Class III orientation. |
| is_pentagon/1 | Returns whether the given index represents a pentagonal cell. |
| is_valid/1 | Returns whethr the given index is valid. |
| k_ring/2 | Produces indices within the given distance K from the given origin Index. |
| k_ring_distances/2 | Produces indices and the associated distance within the given distance K from the given origin Index. |
| max_k_ring_size/1 | Returns the maximum number of indices that result from the k-ring algorithm with the given K. |
| num_hexagons/1 | |
| parent/2 | Returns the parent (coarser) index containing the given Index. |
| to_geo/1 | Finds the centroid of the index. |
| to_geo_boundary/1 | Finds the geo boundary of the given index. |
| to_string/1 | Converts the given index to its string representation. |
| uncompact/2 | Uncompacts given list of indexes to the given resolution. |
children(Index::h3index(), ChildRes::resolution()) -> [h3index(), ...]
Returns the children container by the given Index at the given child resolution ChildRes.
Compacts the given list of indexes as best as possible. Returns a list of at most the same length as the input list.
edge_length_kilometers(X1::resolution()) -> float()
edge_length_meters(X1::resolution()) -> float()
from_geo(X1::coord(), X2::resolution()) -> h3index()
Indexes the location at the specified resolution. Takes the coordinate in degrees.
from_string(X1::string()) -> h3index()
Converts the string representation to an index.
Returns the base cell number of the index.
get_resolution(X1::h3index()) -> resolution()
Returns the resolution of the index.
Returns a unidirectiol edge based on the given origin and destination.
Returns the distance in grid cells between the two
indexes. Throws a badarg if the distance can not be
found. Finding the distance can fail because the two indexes are
not comparable (different resolutions), too far apart, or are
separated by pentagonal distortion.
hex_area_km2(X1::non_neg_integer()) -> float()
hex_area_m2(X1::non_neg_integer()) -> float()
is_class3(X1::h3index()) -> boolean()
Returns whether the given index has a resolution with Class III orientation.
is_pentagon(X1::h3index()) -> boolean()
Returns whether the given index represents a pentagonal cell.
is_valid(X1::h3index()) -> boolean()
Returns whethr the given index is valid.
Produces indices within the given distance K from the given origin Index. k-ring 0 is defined as the origin index, k-ring 1 is defined as k-ring 0 and all neighboring indices, and so on. Output is returned in no particular order.
Produces indices and the associated distance within the given distance K from the given origin Index. k-ring 0 is defined as the origin index, k-ring 1 is defined as k-ring 0 and all neighboring indices, and so on. Output is returned in no particular order.
max_k_ring_size(K::non_neg_integer()) -> non_neg_integer()
Returns the maximum number of indices that result from the k-ring algorithm with the given K.
num_hexagons(X1::resolution()) -> pos_integer()
parent(Index::h3index(), ParentRes::resolution()) -> h3index()
Returns the parent (coarser) index containing the given Index.
Requests for higher resolutions than the the resolution of Index
are an error.
Finds the centroid of the index. Returns the coordinate in degrees.
Finds the geo boundary of the given index. The retuurned list of coordinates is in degrees.
to_string(X1::h3index()) -> string()
Converts the given index to its string representation.
uncompact(X1::[h3index(), ...], X2::resolution()) -> [h3index(), ...]
Uncompacts given list of indexes to the given resolution.
Generated by EDoc