com.uber.h3core

Class H3Core

java.lang.Object

com.uber.h3core.H3Core

public class H3Core
extends Object

H3Core provides all functions of the H3 API.

This class is thread safe and can be used as a singleton.

Method Summary

Modifier and Type	Method and Description
List<Long>	compact(Collection<Long> h3) Returns a compacted set of indexes, at possibly coarser resolutions.
List<String>	compactAddress(Collection<String> h3Addresses) Returns a compacted set of indexes, at possibly coarser resolutions.
double	edgeLength(int res, LengthUnit unit) Returns the average edge length in unit for indexes at resolution res.
CoordIJ	experimentalH3ToLocalIj(long origin, long h3) Converts h3 to IJ coordinates in a local coordinate space defined by origin.
CoordIJ	experimentalH3ToLocalIj(String originAddress, String h3Address) Converts h3Address to IJ coordinates in a local coordinate space defined by originAddress.
long	experimentalLocalIjToH3(long origin, CoordIJ ij) Converts the IJ coordinates to an index, using a local IJ coordinate space anchored by origin.
String	experimentalLocalIjToH3(String originAddress, CoordIJ ij) Converts the IJ coordinates to an index, using a local IJ coordinate space anchored by origin.
long	geoToH3(double lat, double lng, int res) Find the H3 index of the resolution res cell containing the lat/lon (in degrees)
String	geoToH3Address(double lat, double lng, int res) Find the H3 index of the resolution res cell containing the lat/lon (in degrees)
long	getDestinationH3IndexFromUnidirectionalEdge(long h3) Returns the destination index of the given unidirectional edge.
String	getDestinationH3IndexFromUnidirectionalEdge(String h3) Returns the destination index of the given unidirectional edge.
List<Long>	getH3IndexesFromUnidirectionalEdge(long h3) Returns the origin and destination indexes (in that order) of the given unidirectional edge.
List<String>	getH3IndexesFromUnidirectionalEdge(String h3) Returns the origin and destination indexes (in that order) of the given unidirectional edge.
long	getH3UnidirectionalEdge(long a, long b) Returns a unidirectional edge index representing a towards b.
String	getH3UnidirectionalEdge(String a, String b) Returns a unidirectional edge index representing a towards b.
List<GeoCoord>	getH3UnidirectionalEdgeBoundary(long h3) Returns a list of coordinates representing the given edge.
List<GeoCoord>	getH3UnidirectionalEdgeBoundary(String h3) Returns a list of coordinates representing the given edge.
List<Long>	getH3UnidirectionalEdgesFromHexagon(long h3) Returns all unidirectional edges originating from the given index.
List<String>	getH3UnidirectionalEdgesFromHexagon(String h3) Returns all unidirectional edges originating from the given index.
long	getOriginH3IndexFromUnidirectionalEdge(long h3) Returns the origin index of the given unidirectional edge.
String	getOriginH3IndexFromUnidirectionalEdge(String h3) Returns the origin index of the given unidirectional edge.
Collection<Long>	getPentagonIndexes(int res) Returns a collection of all topologically pentagonal cells at the given resolution.
Collection<String>	getPentagonIndexesAddresses(int res) Returns a collection of all topologically pentagonal cells at the given resolution.
Collection<Long>	getRes0Indexes() Returns a collection of all base cells (H3 indexes are resolution 0).
Collection<String>	getRes0IndexesAddresses() Returns a collection of all base cells (H3 indexes are resolution 0).
List<List<List<GeoCoord>>>	h3AddressSetToMultiPolygon(Collection<String> h3Addresses, boolean geoJson) Create polygons from a set of contiguous indexes
int	h3Distance(long a, long b) Returns the distance between a and b.
int	h3Distance(String a, String b) Returns the distance between a and b.
int	h3GetBaseCell(long h3) Returns the base cell number for this index.
int	h3GetBaseCell(String h3Address) Returns the base cell number for this index.
Collection<Integer>	h3GetFaces(long h3) Find all icosahedron faces intersected by a given H3 index, represented as integers from 0-19.
Collection<Integer>	h3GetFaces(String h3) Find all icosahedron faces intersected by a given H3 index, represented as integers from 0-19.
int	h3GetResolution(long h3) Returns the resolution of the provided index
int	h3GetResolution(String h3Address) Returns the resolution of the provided index
boolean	h3IndexesAreNeighbors(long a, long b) Returns true if the two indexes are neighbors.
boolean	h3IndexesAreNeighbors(String a, String b) Returns true if the two indexes are neighbors.
boolean	h3IsPentagon(long h3) Returns true if this index is one of twelve pentagons per resolution.
boolean	h3IsPentagon(String h3Address) Returns true if this index is one of twelve pentagons per resolution.
boolean	h3IsResClassIII(long h3) Determines if an index is Class III or Class II.
boolean	h3IsResClassIII(String h3Address) Determines if an index is Class III or Class II.
boolean	h3IsValid(long h3) Returns true if this is a valid H3 index.
boolean	h3IsValid(String h3Address) Returns true if this is a valid H3 index.
List<Long>	h3Line(long start, long end) Given two H3 indexes, return the line of indexes between them (inclusive of endpoints).
List<String>	h3Line(String startAddress, String endAddress) Given two H3 indexes, return the line of indexes between them (inclusive of endpoints).
List<List<List<GeoCoord>>>	h3SetToMultiPolygon(Collection<Long> h3, boolean geoJson) Create polygons from a set of contiguous indexes
long	h3ToCenterChild(long h3, int childRes) Returns the center child at the given resolution.
String	h3ToCenterChild(String h3, int childRes) Returns the center child at the given resolution.
List<Long>	h3ToChildren(long h3, int childRes) Provides the children of the index at the given resolution.
List<String>	h3ToChildren(String h3Address, int childRes) Provides the children of the index at the given resolution.
GeoCoord	h3ToGeo(long h3) Find the latitude, longitude (both in degrees) center point of the cell.
GeoCoord	h3ToGeo(String h3Address) Find the latitude, longitude (degrees) center point of the cell.
List<GeoCoord>	h3ToGeoBoundary(long h3) Find the cell boundary in latitude, longitude (degrees) coordinates for the cell
List<GeoCoord>	h3ToGeoBoundary(String h3Address) Find the cell boundary in latitude, longitude (degrees) coordinates for the cell
long	h3ToParent(long h3, int res) Returns the parent of the index at the given resolution.
String	h3ToParentAddress(String h3Address, int res) Returns the parent of the index at the given resolution.
String	h3ToString(long h3) Converts from long representation of an index to String representation.
boolean	h3UnidirectionalEdgeIsValid(long h3) Returns true if the given index is a valid unidirectional edge.
boolean	h3UnidirectionalEdgeIsValid(String h3) Returns true if the given index is a valid unidirectional edge.
double	hexArea(int res, AreaUnit unit) Returns the average area in unit for indexes at resolution res.
List<List<Long>>	hexRange(long h3, int k) Returns in order neighbor traversal.
List<List<String>>	hexRange(String h3Address, int k) Returns in order neighbor traversal.
List<Long>	hexRing(long h3, int k) Returns in order neighbor traversal, of indexes with distance of k.
List<String>	hexRing(String h3Address, int k) Returns in order neighbor traversal, of indexes with distance of k.
List<Long>	kRing(long h3, int k) Neighboring indexes in all directions.
List<String>	kRing(String h3Address, int k) Neighboring indexes in all directions.
List<List<Long>>	kRingDistances(long h3, int k) Neighboring indexes in all directions, ordered by distance from the origin index.
List<List<String>>	kRingDistances(String h3Address, int k) Neighboring indexes in all directions, ordered by distance from the origin index.
List<List<String>>	kRings(String h3Address, int k) Neighboring indexes in all directions.
static H3Core	newInstance() Create by unpacking the H3 native library to disk and loading it.
static H3Core	newInstance(H3CoreLoader.OperatingSystem os, String arch) Create by unpacking the H3 native library to disk and loading it.
static H3Core	newSystemInstance() Create by using the H3 native library already installed on the system.
long	numHexagons(int res) Returns the number of unique H3 indexes at resolution res.
List<Long>	polyfill(List<GeoCoord> points, List<List<GeoCoord>> holes, int res) Finds indexes within the given geofence.
List<String>	polyfillAddress(List<GeoCoord> points, List<List<GeoCoord>> holes, int res) Finds indexes within the given geofence.
long	stringToH3(String h3Address) Converts from String representation of an index to long representation.
List<Long>	uncompact(Collection<Long> h3, int res) Uncompacts all the given indexes to resolution res.
List<String>	uncompactAddress(Collection<String> h3Addresses, int res) Uncompacts all the given indexes to resolution res.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newInstance

public static H3Core newInstance()
                          throws IOException

Create by unpacking the H3 native library to disk and loading it. The library will attempt to detect the correct operating system and architecture of native library to unpack.

Throws:

SecurityException - Loading the library was not allowed by the SecurityManager.

UnsatisfiedLinkError - The library could not be loaded

IOException - The library could not be extracted to disk.

newInstance

public static H3Core newInstance(H3CoreLoader.OperatingSystem os,
                                 String arch)
                          throws IOException

Create by unpacking the H3 native library to disk and loading it. The library will attempt to extract the native library matching the given arguments to disk.

Throws:

SecurityException - Loading the library was not allowed by the SecurityManager.

UnsatisfiedLinkError - The library could not be loaded

IOException - The library could not be extracted to disk.

newSystemInstance

public static H3Core newSystemInstance()

Create by using the H3 native library already installed on the system.

Throws:

SecurityException - The library could not be loaded

UnsatisfiedLinkError - The library could not be loaded

h3IsValid

public boolean h3IsValid(long h3)

Returns true if this is a valid H3 index.

h3IsValid

public boolean h3IsValid(String h3Address)

Returns true if this is a valid H3 index.

h3GetBaseCell

public int h3GetBaseCell(long h3)

Returns the base cell number for this index.

h3GetBaseCell

public int h3GetBaseCell(String h3Address)

Returns the base cell number for this index.

h3IsPentagon

public boolean h3IsPentagon(long h3)

Returns true if this index is one of twelve pentagons per resolution.

h3IsPentagon

public boolean h3IsPentagon(String h3Address)

Returns true if this index is one of twelve pentagons per resolution.

geoToH3

public long geoToH3(double lat,
                    double lng,
                    int res)

Find the H3 index of the resolution res cell containing the lat/lon (in degrees)

Parameters:

lat - Latitude in degrees.

lng - Longitude in degrees.

res - Resolution, 0 <= res <= 15

Returns:

The H3 index.

Throws:

IllegalArgumentException - latitude, longitude, or resolution are out of range.

geoToH3Address

public String geoToH3Address(double lat,
                             double lng,
                             int res)

Find the H3 index of the resolution res cell containing the lat/lon (in degrees)

Parameters:

lat - Latitude in degrees.

lng - Longitude in degrees.

res - Resolution, 0 <= res <= 15

Returns:

The H3 index.

Throws:

IllegalArgumentException - Latitude, longitude, or resolution is out of range.

h3ToGeo

public GeoCoord h3ToGeo(long h3)

Find the latitude, longitude (both in degrees) center point of the cell.

h3ToGeo

public GeoCoord h3ToGeo(String h3Address)

Find the latitude, longitude (degrees) center point of the cell.

h3ToGeoBoundary

public List<GeoCoord> h3ToGeoBoundary(long h3)

Find the cell boundary in latitude, longitude (degrees) coordinates for the cell

h3ToGeoBoundary

public List<GeoCoord> h3ToGeoBoundary(String h3Address)

Find the cell boundary in latitude, longitude (degrees) coordinates for the cell

kRing

public List<String> kRing(String h3Address,
                          int k)

Neighboring indexes in all directions.

Parameters:

h3Address - Origin index

k - Number of rings around the origin

kRings

public List<List<String>> kRings(String h3Address,
                                 int k)

Neighboring indexes in all directions.

Parameters:

h3Address - Origin index

k - Number of rings around the origin

Returns:

List of kRing(String, int) results.

kRing

public List<Long> kRing(long h3,
                        int k)

Neighboring indexes in all directions.

Parameters:

h3 - Origin index

k - Number of rings around the origin

kRingDistances

public List<List<String>> kRingDistances(String h3Address,
                                         int k)

Neighboring indexes in all directions, ordered by distance from the origin index.

Parameters:

h3Address - Origin index

k - Number of rings around the origin

Returns:

A list of rings, each of which is a list of addresses. The rings are in order from closest to origin to farthest.

kRingDistances

public List<List<Long>> kRingDistances(long h3,
                                       int k)

Neighboring indexes in all directions, ordered by distance from the origin index.

Parameters:

h3 - Origin index

k - Number of rings around the origin

Returns:

A list of rings, each of which is a list of addresses. The rings are in order from closest to origin to farthest.

hexRange

public List<List<String>> hexRange(String h3Address,
                                   int k)
                            throws PentagonEncounteredException

Returns in order neighbor traversal.

Parameters:

h3Address - Origin hexagon index

k - Number of rings around the origin

Returns:

A list of rings, each of which is a list of addresses. The rings are in order from closest to origin to farthest.

Throws:

PentagonEncounteredException - A pentagon was encountered while iterating the rings

hexRange

public List<List<Long>> hexRange(long h3,
                                 int k)
                          throws PentagonEncounteredException

Returns in order neighbor traversal.

Parameters:

h3 - Origin hexagon index

k - Number of rings around the origin

Returns:

A list of rings, each of which is a list of addresses. The rings are in order from closest to origin to farthest.

Throws:

PentagonEncounteredException - A pentagon was encountered while iterating the rings

hexRing

public List<String> hexRing(String h3Address,
                            int k)
                     throws PentagonEncounteredException

Returns in order neighbor traversal, of indexes with distance of k.

Parameters:

h3Address - Origin index

k - Number of rings around the origin

Returns:

All indexes k away from the origin

Throws:

PentagonEncounteredException - A pentagon or pentagonal distortion was encountered.

hexRing

public List<Long> hexRing(long h3,
                          int k)
                   throws PentagonEncounteredException

Returns in order neighbor traversal, of indexes with distance of k.

Parameters:

h3 - Origin index

k - Number of rings around the origin

Returns:

All indexes k away from the origin

Throws:

PentagonEncounteredException - A pentagon or pentagonal distortion was encountered.

h3Distance

public int h3Distance(String a,
                      String b)
               throws DistanceUndefinedException

Returns the distance between a and b. This is the grid distance, or distance expressed in number of H3 cells.

In some cases H3 cannot compute the distance between two indexes. This can happen because:

• The indexes are not comparable (difference resolutions, etc)
• The distance is greater than the H3 core library supports
• The H3 library does not support finding the distance between the two cells, because of pentagonal distortion.

Parameters:

a - An H3 index

b - Another H3 index

Returns:

Distance between the two in grid cells

Throws:

DistanceUndefinedException - H3 cannot compute the distance.

h3Distance

public int h3Distance(long a,
                      long b)
               throws DistanceUndefinedException

Returns the distance between a and b. This is the grid distance, or distance expressed in number of H3 cells.

In some cases H3 cannot compute the distance between two indexes. This can happen because:

• The indexes are not comparable (difference resolutions, etc)
• The distance is greater than the H3 core library supports
• The H3 library does not support finding the distance between the two cells, because of pentagonal distortion.

Parameters:

a - An H3 index

b - Another H3 index

Returns:

Distance between the two in grid cells

Throws:

DistanceUndefinedException - H3 cannot compute the distance.

experimentalH3ToLocalIj

public CoordIJ experimentalH3ToLocalIj(long origin,
                                       long h3)
                                throws PentagonEncounteredException,
                                       LocalIjUndefinedException

Converts h3 to IJ coordinates in a local coordinate space defined by origin.

The local IJ coordinate space may have deleted regions and warping due to pentagon distortion. IJ coordinates are only comparable if they came from the same origin.

This function is experimental, and its output is not guaranteed to be compatible across different versions of H3.

Parameters:

origin - Anchoring index for the local coordinate space.

h3 - Index to find the coordinates of.

Returns:

Coordinates for h3 in the local coordinate space.

Throws:

IllegalArgumentException - The two indexes are not comparable.

PentagonEncounteredException - The two indexes are separated by pentagonal distortion.

LocalIjUndefinedException - The two indexes are too far apart.

experimentalH3ToLocalIj

public CoordIJ experimentalH3ToLocalIj(String originAddress,
                                       String h3Address)
                                throws PentagonEncounteredException,
                                       LocalIjUndefinedException

Converts h3Address to IJ coordinates in a local coordinate space defined by originAddress.

The local IJ coordinate space may have deleted regions and warping due to pentagon distortion. IJ coordinates are only comparable if they came from the same origin.

This function is experimental, and its output is not guaranteed to be compatible across different versions of H3.

Parameters:

originAddress - Anchoring index for the local coordinate space.

h3Address - Index to find the coordinates of.

Returns:

Coordinates for h3 in the local coordinate space.

Throws:

IllegalArgumentException - The two indexes are not comparable.

PentagonEncounteredException - The two indexes are separated by pentagonal distortion.

LocalIjUndefinedException - The two indexes are too far apart.

experimentalLocalIjToH3

public long experimentalLocalIjToH3(long origin,
                                    CoordIJ ij)
                             throws LocalIjUndefinedException

Converts the IJ coordinates to an index, using a local IJ coordinate space anchored by origin.

The local IJ coordinate space may have deleted regions and warping due to pentagon distortion. IJ coordinates are only comparable if they came from the same origin.

This function is experimental, and its output is not guaranteed to be compatible across different versions of H3.

Parameters:

origin - Anchoring index for the local coordinate space.

ij - Coordinates in the local IJ coordinate space.

Returns:

Index represented by ij

Throws:

LocalIjUndefinedException - No index is defined at the given location, for example because the coordinates are too far away from the origin, or pentagon distortion is encountered.

experimentalLocalIjToH3

public String experimentalLocalIjToH3(String originAddress,
                                      CoordIJ ij)
                               throws LocalIjUndefinedException

Converts the IJ coordinates to an index, using a local IJ coordinate space anchored by origin.

The local IJ coordinate space may have deleted regions and warping due to pentagon distortion. IJ coordinates are only comparable if they came from the same origin.

This function is experimental, and its output is not guaranteed to be compatible across different versions of H3.

Parameters:

originAddress - Anchoring index for the local coordinate space.

ij - Coordinates in the local IJ coordinate space.

Returns:

Index represented by ij

Throws:

LocalIjUndefinedException - No index is defined at the given location, for example because the coordinates are too far away from the origin, or pentagon distortion is encountered.

h3Line

public List<String> h3Line(String startAddress,
                           String endAddress)
                    throws LineUndefinedException

Given two H3 indexes, return the line of indexes between them (inclusive of endpoints).

This function may fail to find the line between two indexes, for example if they are very far apart. It may also fail when finding distances for indexes on opposite sides of a pentagon.

Notes:

• The specific output of this function should not be considered stable across library versions. The only guarantees the library provides are that the line length will be `h3Distance(start, end) + 1` and that every index in the line will be a neighbor of the preceding index.
• Lines are drawn in grid space, and may not correspond exactly to either Cartesian lines or great arcs.

Parameters:

startAddress - Start index of the line

endAddress - End index of the line

Returns:

Indexes making up the line.

Throws:

LineUndefinedException - The line could not be computed.

h3Line

public List<Long> h3Line(long start,
                         long end)
                  throws LineUndefinedException

Given two H3 indexes, return the line of indexes between them (inclusive of endpoints).

This function may fail to find the line between two indexes, for example if they are very far apart. It may also fail when finding distances for indexes on opposite sides of a pentagon.

Notes:

• The specific output of this function should not be considered stable across library versions. The only guarantees the library provides are that the line length will be `h3Distance(start, end) + 1` and that every index in the line will be a neighbor of the preceding index.
• Lines are drawn in grid space, and may not correspond exactly to either Cartesian lines or great arcs.

Parameters:

start - Start index of the line

end - End index of the line

Returns:

Indexes making up the line.

Throws:

LineUndefinedException - The line could not be computed.

polyfillAddress

public List<String> polyfillAddress(List<GeoCoord> points,
                                    List<List<GeoCoord>> holes,
                                    int res)

Finds indexes within the given geofence.

Parameters:

points - Outline geofence

holes - Geofences of any internal holes

res - Resolution of the desired indexes

polyfill

public List<Long> polyfill(List<GeoCoord> points,
                           List<List<GeoCoord>> holes,
                           int res)

Finds indexes within the given geofence.

Parameters:

points - Outline geofence

holes - Geofences of any internal holes

res - Resolution of the desired indexes

Throws:

IllegalArgumentException - Invalid resolution

h3AddressSetToMultiPolygon

public List<List<List<GeoCoord>>> h3AddressSetToMultiPolygon(Collection<String> h3Addresses,
                                                             boolean geoJson)

Create polygons from a set of contiguous indexes

h3SetToMultiPolygon

public List<List<List<GeoCoord>>> h3SetToMultiPolygon(Collection<Long> h3,
                                                      boolean geoJson)

Create polygons from a set of contiguous indexes

h3GetResolution

public int h3GetResolution(String h3Address)

Returns the resolution of the provided index

h3GetResolution

public int h3GetResolution(long h3)

Returns the resolution of the provided index

h3ToParent

public long h3ToParent(long h3,
                       int res)

Returns the parent of the index at the given resolution.

Parameters:

h3 - H3 index.

res - Resolution of the parent, 0 <= res <= h3GetResolution(h3)

Throws:

IllegalArgumentException - res is not between 0 and the resolution of h3, inclusive.

h3ToParentAddress

public String h3ToParentAddress(String h3Address,
                                int res)

Returns the parent of the index at the given resolution.

Parameters:

h3Address - H3 index.

res - Resolution of the parent, 0 <= res <= h3GetResolution(h3)

h3ToChildren

public List<String> h3ToChildren(String h3Address,
                                 int childRes)

Provides the children of the index at the given resolution.

Parameters:

childRes - Resolution of the children

h3ToChildren

public List<Long> h3ToChildren(long h3,
                               int childRes)

Provides the children of the index at the given resolution.

Parameters:

h3 - H3 index.

childRes - Resolution of the children

Throws:

IllegalArgumentException - Invalid resolution

h3ToCenterChild

public String h3ToCenterChild(String h3,
                              int childRes)

Returns the center child at the given resolution.

Parameters:

h3 - Parent H3 index

childRes - Resolution of the child

Throws:

IllegalArgumentException - Invalid resolution (e.g. coarser than the parent)

h3ToCenterChild

public long h3ToCenterChild(long h3,
                            int childRes)

Returns the center child at the given resolution.

Parameters:

h3 - Parent H3 index

childRes - Resolution of the child

Throws:

IllegalArgumentException - Invalid resolution (e.g. coarser than the parent)

h3IsResClassIII

public boolean h3IsResClassIII(String h3Address)

Determines if an index is Class III or Class II.

Returns:

true if the index is Class III

h3IsResClassIII

public boolean h3IsResClassIII(long h3)

Determines if an index is Class III or Class II.

Parameters:

h3 - H3 index.

Returns:

true if the index is Class III

compactAddress

public List<String> compactAddress(Collection<String> h3Addresses)

Returns a compacted set of indexes, at possibly coarser resolutions.

compact

public List<Long> compact(Collection<Long> h3)

Returns a compacted set of indexes, at possibly coarser resolutions.

Throws:

IllegalArgumentException - Invalid input, such as duplicated indexes.

uncompactAddress

public List<String> uncompactAddress(Collection<String> h3Addresses,
                                     int res)

Uncompacts all the given indexes to resolution res.

uncompact

public List<Long> uncompact(Collection<Long> h3,
                            int res)

Uncompacts all the given indexes to resolution res.

Throws:

IllegalArgumentException - Invalid input, such as indexes finer than res.

h3ToString

public String h3ToString(long h3)

Converts from long representation of an index to String representation.

stringToH3

public long stringToH3(String h3Address)

Converts from String representation of an index to long representation.

hexArea

public double hexArea(int res,
                      AreaUnit unit)

Returns the average area in unit for indexes at resolution res.

Throws:

IllegalArgumentException - Invalid parameter value

edgeLength

public double edgeLength(int res,
                         LengthUnit unit)

Returns the average edge length in unit for indexes at resolution res.

Throws:

IllegalArgumentException - Invalid parameter value

numHexagons

public long numHexagons(int res)

Returns the number of unique H3 indexes at resolution res.

Throws:

IllegalArgumentException - Invalid resolution

getRes0IndexesAddresses

public Collection<String> getRes0IndexesAddresses()

Returns a collection of all base cells (H3 indexes are resolution 0).

getRes0Indexes

public Collection<Long> getRes0Indexes()

Returns a collection of all base cells (H3 indexes are resolution 0).

getPentagonIndexesAddresses

public Collection<String> getPentagonIndexesAddresses(int res)

Returns a collection of all topologically pentagonal cells at the given resolution.

Throws:

IllegalArgumentException - Invalid resolution.

getPentagonIndexes

public Collection<Long> getPentagonIndexes(int res)

Returns a collection of all topologically pentagonal cells at the given resolution.

Throws:

IllegalArgumentException - Invalid resolution.

h3IndexesAreNeighbors

public boolean h3IndexesAreNeighbors(long a,
                                     long b)

Returns true if the two indexes are neighbors.

h3IndexesAreNeighbors

public boolean h3IndexesAreNeighbors(String a,
                                     String b)

Returns true if the two indexes are neighbors.

getH3UnidirectionalEdge

public long getH3UnidirectionalEdge(long a,
                                    long b)

Returns a unidirectional edge index representing a towards b.

Throws:

IllegalArgumentException - The indexes are not neighbors.

getH3UnidirectionalEdge

public String getH3UnidirectionalEdge(String a,
                                      String b)

Returns a unidirectional edge index representing a towards b.

Throws:

IllegalArgumentException - The indexes are not neighbors.

h3UnidirectionalEdgeIsValid

public boolean h3UnidirectionalEdgeIsValid(long h3)

Returns true if the given index is a valid unidirectional edge.

h3UnidirectionalEdgeIsValid

public boolean h3UnidirectionalEdgeIsValid(String h3)

Returns true if the given index is a valid unidirectional edge.

getOriginH3IndexFromUnidirectionalEdge

public long getOriginH3IndexFromUnidirectionalEdge(long h3)

Returns the origin index of the given unidirectional edge.

getOriginH3IndexFromUnidirectionalEdge

public String getOriginH3IndexFromUnidirectionalEdge(String h3)

Returns the origin index of the given unidirectional edge.

getDestinationH3IndexFromUnidirectionalEdge

public long getDestinationH3IndexFromUnidirectionalEdge(long h3)

Returns the destination index of the given unidirectional edge.

getDestinationH3IndexFromUnidirectionalEdge

public String getDestinationH3IndexFromUnidirectionalEdge(String h3)

Returns the destination index of the given unidirectional edge.

getH3IndexesFromUnidirectionalEdge

public List<Long> getH3IndexesFromUnidirectionalEdge(long h3)

Returns the origin and destination indexes (in that order) of the given unidirectional edge.

getH3IndexesFromUnidirectionalEdge

public List<String> getH3IndexesFromUnidirectionalEdge(String h3)

Returns the origin and destination indexes (in that order) of the given unidirectional edge.

getH3UnidirectionalEdgesFromHexagon

public List<Long> getH3UnidirectionalEdgesFromHexagon(long h3)

Returns all unidirectional edges originating from the given index.

getH3UnidirectionalEdgesFromHexagon

public List<String> getH3UnidirectionalEdgesFromHexagon(String h3)

Returns all unidirectional edges originating from the given index.

getH3UnidirectionalEdgeBoundary

public List<GeoCoord> getH3UnidirectionalEdgeBoundary(long h3)

Returns a list of coordinates representing the given edge.

getH3UnidirectionalEdgeBoundary

public List<GeoCoord> getH3UnidirectionalEdgeBoundary(String h3)

Returns a list of coordinates representing the given edge.

h3GetFaces

public Collection<Integer> h3GetFaces(String h3)

Find all icosahedron faces intersected by a given H3 index, represented as integers from 0-19.

Parameters:

h3 - Index to find icosahedron faces for.

Returns:

A collection of faces intersected by the index.

h3GetFaces

public Collection<Integer> h3GetFaces(long h3)

Find all icosahedron faces intersected by a given H3 index, represented as integers from 0-19.

Parameters:

h3 - Index to find icosahedron faces for.

Returns:

A collection of faces intersected by the index.