Index (h3 3.3.0 API)

A C D E G H I J K L N P S T U V

A

AreaUnit - Enum in com.uber.h3core: Unit of measurement for areas.

C

com.uber.h3core - package com.uber.h3core
com.uber.h3core.exceptions - package com.uber.h3core.exceptions
com.uber.h3core.util - package com.uber.h3core.util
compact(Collection<Long>) - Method in class com.uber.h3core.H3Core: Returns a compacted set of indexes, at possibly coarser resolutions.
compactAddress(Collection<String>) - Method in class com.uber.h3core.H3Core: Returns a compacted set of indexes, at possibly coarser resolutions.
CoordIJ - Class in com.uber.h3core.util: Immutable two-dimensional IJ grid coordinates.
CoordIJ(int, int) - Constructor for class com.uber.h3core.util.CoordIJ

D

DistanceUndefinedException - Exception in com.uber.h3core.exceptions: The distance could not be computed between two cells.
DistanceUndefinedException(String) - Constructor for exception com.uber.h3core.exceptions.DistanceUndefinedException

E

edgeLength(int, LengthUnit) - Method in class com.uber.h3core.H3Core: Returns the average edge length in unit for indexes at resolution res.
equals(Object) - Method in class com.uber.h3core.util.CoordIJ
equals(Object) - Method in class com.uber.h3core.util.GeoCoord
experimentalH3ToLocalIj(long, long) - Method in class com.uber.h3core.H3Core: Converts h3 to IJ coordinates in a local coordinate space defined by origin.
experimentalH3ToLocalIj(String, String) - Method in class com.uber.h3core.H3Core: Converts h3Address to IJ coordinates in a local coordinate space defined by originAddress.
experimentalLocalIjToH3(long, CoordIJ) - Method in class com.uber.h3core.H3Core: Converts the IJ coordinates to an index, using a local IJ coordinate space anchored by origin.
experimentalLocalIjToH3(String, CoordIJ) - Method in class com.uber.h3core.H3Core: Converts the IJ coordinates to an index, using a local IJ coordinate space anchored by origin.

G

GeoCoord - Class in com.uber.h3core.util: Immutable two-dimensional spherical coordinates, in degrees.
GeoCoord(double, double) - Constructor for class com.uber.h3core.util.GeoCoord
geoToH3(double, double, int) - Method in class com.uber.h3core.H3Core: Find the H3 index of the resolution res cell containing the lat/lon (in degrees)
geoToH3Address(double, double, int) - Method in class com.uber.h3core.H3Core: Find the H3 index of the resolution res cell containing the lat/lon (in degrees)
getDestinationH3IndexFromUnidirectionalEdge(long) - Method in class com.uber.h3core.H3Core: Returns the destination index of the given unidirectional edge.
getDestinationH3IndexFromUnidirectionalEdge(String) - Method in class com.uber.h3core.H3Core: Returns the destination index of the given unidirectional edge.
getDirName() - Method in enum com.uber.h3core.H3CoreLoader.OperatingSystem: How this operating system's name is rendered when extracting the native library.
getH3IndexesFromUnidirectionalEdge(long) - Method in class com.uber.h3core.H3Core: Returns the origin and destination indexes (in that order) of the given unidirectional edge.
getH3IndexesFromUnidirectionalEdge(String) - Method in class com.uber.h3core.H3Core: Returns the origin and destination indexes (in that order) of the given unidirectional edge.
getH3UnidirectionalEdge(long, long) - Method in class com.uber.h3core.H3Core: Returns a unidirectional edge index representing a towards b.
getH3UnidirectionalEdge(String, String) - Method in class com.uber.h3core.H3Core: Returns a unidirectional edge index representing a towards b.
getH3UnidirectionalEdgeBoundary(long) - Method in class com.uber.h3core.H3Core: Returns a list of coordinates representing the given edge.
getH3UnidirectionalEdgeBoundary(String) - Method in class com.uber.h3core.H3Core: Returns a list of coordinates representing the given edge.
getH3UnidirectionalEdgesFromHexagon(long) - Method in class com.uber.h3core.H3Core: Returns all unidirectional edges originating from the given index.
getH3UnidirectionalEdgesFromHexagon(String) - Method in class com.uber.h3core.H3Core: Returns all unidirectional edges originating from the given index.
getOriginH3IndexFromUnidirectionalEdge(long) - Method in class com.uber.h3core.H3Core: Returns the origin index of the given unidirectional edge.
getOriginH3IndexFromUnidirectionalEdge(String) - Method in class com.uber.h3core.H3Core: Returns the origin index of the given unidirectional edge.
getSuffix() - Method in enum com.uber.h3core.H3CoreLoader.OperatingSystem: Suffix for native libraries.

H

h3AddressSetToMultiPolygon(Collection<String>, boolean) - Method in class com.uber.h3core.H3Core: Create polygons from a set of contiguous indexes
H3Core - Class in com.uber.h3core: H3Core provides all functions of the H3 API.
H3CoreLoader - Class in com.uber.h3core: Extracts the native H3 core library to the local filesystem and loads it.
H3CoreLoader.OperatingSystem - Enum in com.uber.h3core: Operating systems supported by H3-Java.
h3Distance(String, String) - Method in class com.uber.h3core.H3Core: Returns the distance between a and b.
h3Distance(long, long) - Method in class com.uber.h3core.H3Core: Returns the distance between a and b.
h3GetBaseCell(long) - Method in class com.uber.h3core.H3Core: Returns the base cell number for this index.
h3GetBaseCell(String) - Method in class com.uber.h3core.H3Core: Returns the base cell number for this index.
h3GetResolution(String) - Method in class com.uber.h3core.H3Core: Returns the resolution of the provided index
h3GetResolution(long) - Method in class com.uber.h3core.H3Core: Returns the resolution of the provided index
h3IndexesAreNeighbors(long, long) - Method in class com.uber.h3core.H3Core: Returns true if the two indexes are neighbors.
h3IndexesAreNeighbors(String, String) - Method in class com.uber.h3core.H3Core: Returns true if the two indexes are neighbors.
h3IsPentagon(long) - Method in class com.uber.h3core.H3Core: Returns true if this index is one of twelve pentagons per resolution.
h3IsPentagon(String) - Method in class com.uber.h3core.H3Core: Returns true if this index is one of twelve pentagons per resolution.
h3IsResClassIII(String) - Method in class com.uber.h3core.H3Core: Determines if an index is Class III or Class II.
h3IsResClassIII(long) - Method in class com.uber.h3core.H3Core: Determines if an index is Class III or Class II.
h3IsValid(long) - Method in class com.uber.h3core.H3Core: Returns true if this is a valid H3 index.
h3IsValid(String) - Method in class com.uber.h3core.H3Core: Returns true if this is a valid H3 index.
h3Line(String, String) - Method in class com.uber.h3core.H3Core: Given two H3 indexes, return the line of indexes between them (inclusive of endpoints).
h3Line(long, long) - Method in class com.uber.h3core.H3Core: Given two H3 indexes, return the line of indexes between them (inclusive of endpoints).
h3SetToMultiPolygon(Collection<Long>, boolean) - Method in class com.uber.h3core.H3Core: Create polygons from a set of contiguous indexes
h3ToChildren(String, int) - Method in class com.uber.h3core.H3Core: Provides the children of the index at the given resolution.
h3ToChildren(long, int) - Method in class com.uber.h3core.H3Core: Provides the children of the index at the given resolution.
h3ToGeo(long) - Method in class com.uber.h3core.H3Core: Find the latitude, longitude (both in degrees) center point of the cell.
h3ToGeo(String) - Method in class com.uber.h3core.H3Core: Find the latitude, longitude (degrees) center point of the cell.
h3ToGeoBoundary(long) - Method in class com.uber.h3core.H3Core: Find the cell boundary in latitude, longitude (degrees) coordinates for the cell
h3ToGeoBoundary(String) - Method in class com.uber.h3core.H3Core: Find the cell boundary in latitude, longitude (degrees) coordinates for the cell
h3ToParent(long, int) - Method in class com.uber.h3core.H3Core: Returns the parent of the index at the given resolution.
h3ToParentAddress(String, int) - Method in class com.uber.h3core.H3Core: Returns the parent of the index at the given resolution.
h3ToString(long) - Method in class com.uber.h3core.H3Core: Converts from long representation of an index to String representation.
h3UnidirectionalEdgeIsValid(long) - Method in class com.uber.h3core.H3Core: Returns true if the given index is a valid unidirectional edge.
h3UnidirectionalEdgeIsValid(String) - Method in class com.uber.h3core.H3Core: Returns true if the given index is a valid unidirectional edge.
hashCode() - Method in class com.uber.h3core.util.CoordIJ
hashCode() - Method in class com.uber.h3core.util.GeoCoord
hexArea(int, AreaUnit) - Method in class com.uber.h3core.H3Core: Returns the average area in unit for indexes at resolution res.
hexRange(String, int) - Method in class com.uber.h3core.H3Core: Returns in order neighbor traversal.
hexRange(long, int) - Method in class com.uber.h3core.H3Core: Returns in order neighbor traversal.
hexRing(String, int) - Method in class com.uber.h3core.H3Core: Returns in order neighbor traversal, of indexes with distance of k.
hexRing(long, int) - Method in class com.uber.h3core.H3Core: Returns in order neighbor traversal, of indexes with distance of k.

I

i - Variable in class com.uber.h3core.util.CoordIJ

J

j - Variable in class com.uber.h3core.util.CoordIJ

K

kRing(String, int) - Method in class com.uber.h3core.H3Core: Neighboring indexes in all directions.
kRing(long, int) - Method in class com.uber.h3core.H3Core: Neighboring indexes in all directions.
kRingDistances(String, int) - Method in class com.uber.h3core.H3Core: Neighboring indexes in all directions, ordered by distance from the origin index.
kRingDistances(long, int) - Method in class com.uber.h3core.H3Core: Neighboring indexes in all directions, ordered by distance from the origin index.
kRings(String, int) - Method in class com.uber.h3core.H3Core: Neighboring indexes in all directions.

L

lat - Variable in class com.uber.h3core.util.GeoCoord
LengthUnit - Enum in com.uber.h3core: Unit of measurement for lengths.
LineUndefinedException - Exception in com.uber.h3core.exceptions: The line could not be computed between two cells.
LineUndefinedException(String) - Constructor for exception com.uber.h3core.exceptions.LineUndefinedException
lng - Variable in class com.uber.h3core.util.GeoCoord
loadNatives() - Static method in class com.uber.h3core.H3CoreLoader: For use when the H3 library should be unpacked from the JAR and loaded.
loadNatives(H3CoreLoader.OperatingSystem, String) - Static method in class com.uber.h3core.H3CoreLoader: For use when the H3 library should be unpacked from the JAR and loaded.
loadSystemNatives() - Static method in class com.uber.h3core.H3CoreLoader: For use when the H3 library is installed system-wide and Java is able to locate it.
LocalIjUndefinedException - Exception in com.uber.h3core.exceptions: The local IJ coordinates could not be determined for an index, or the index could not be determined for IJ coordinates.
LocalIjUndefinedException(String) - Constructor for exception com.uber.h3core.exceptions.LocalIjUndefinedException

N

newInstance() - Static method in class com.uber.h3core.H3Core: Create by unpacking the H3 native library to disk and loading it.
newInstance(H3CoreLoader.OperatingSystem, String) - Static method in class com.uber.h3core.H3Core: Create by unpacking the H3 native library to disk and loading it.
newSystemInstance() - Static method in class com.uber.h3core.H3Core: Create by using the H3 native library already installed on the system.
numHexagons(int) - Method in class com.uber.h3core.H3Core: Returns the number of unique H3 indexes at resolution res.

P

PentagonEncounteredException - Exception in com.uber.h3core.exceptions: An H3 algorithm encountered a pentagon and was unable to continue.
PentagonEncounteredException(String) - Constructor for exception com.uber.h3core.exceptions.PentagonEncounteredException
polyfill(List<GeoCoord>, List<List<GeoCoord>>, int) - Method in class com.uber.h3core.H3Core: Finds indexes within the given geofence.
polyfillAddress(List<GeoCoord>, List<List<GeoCoord>>, int) - Method in class com.uber.h3core.H3Core: Finds indexes within the given geofence.

S

stringToH3(String) - Method in class com.uber.h3core.H3Core: Converts from String representation of an index to long representation.

T

toString() - Method in class com.uber.h3core.util.CoordIJ
toString() - Method in class com.uber.h3core.util.GeoCoord

U

uncompact(Collection<Long>, int) - Method in class com.uber.h3core.H3Core: Uncompacts all the given indexes to resolution res.
uncompactAddress(Collection<String>, int) - Method in class com.uber.h3core.H3Core: Uncompacts all the given indexes to resolution res.

V

valueOf(String) - Static method in enum com.uber.h3core.AreaUnit: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.uber.h3core.H3CoreLoader.OperatingSystem: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.uber.h3core.LengthUnit: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.uber.h3core.AreaUnit: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.uber.h3core.H3CoreLoader.OperatingSystem: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.uber.h3core.LengthUnit: Returns an array containing the constants of this enum type, in the order they are declared.

A C D E G H I J K L N P S T U V