h3

package module

Go to main page

Versions in this module

v4

v4.2.0

Dec 27, 2024

Changes in this version

+ var ErrCellInvalid = errors.New("H3Index cell argument was not valid")

+ var ErrDirectedEdgeInvalid = errors.New("H3Index directed edge argument was not valid")

+ var ErrDomain = errors.New("argument was outside of acceptable range")

+ var ErrDuplicateInput = errors.New("duplicate input was encountered in the arguments")

+ var ErrFailed = errors.New("the operation failed")

+ var ErrLatLngDomain = errors.New("latitude or longitude arguments were outside of acceptable range")

+ var ErrMemoryAlloc = errors.New("necessary memory allocation failed")

+ var ErrMemoryBounds = errors.New("bounds of provided memory were not large enough")

+ var ErrNotNeighbors = errors.New("H3Index cell arguments were not neighbors")

+ var ErrOptionInvalid = errors.New("mode or flags argument was not valid")

+ var ErrPentagon = errors.New("pentagon distortion was encountered")

+ var ErrResolutionDomain = errors.New("resolution argument was outside of acceptable range")

+ var ErrRsolutionMismatch = errors.New("H3Index cell arguments had incompatible resolutions")

+ var ErrUndirectedEdgeInvalid = errors.New("H3Index undirected edge argument was not valid")

+ var ErrUnknown = errors.New("unknown error code returned by H3")

+ var ErrVertexInvalid = errors.New("H3Index vertex argument was not valid")

v4.1.2

Aug 26, 2024

Changes in this version

+ func IsValidVertex(c Cell) bool

type Cell

+ func CellToVertex(c Cell, vertexNum int) Cell

+ func CellToVertexes(c Cell) []Cell

type LatLng

+ func VertexToLatLng(vertex Cell) LatLng

v4.1.1

Aug 12, 2024

v4.1.0

Mar 23, 2023

Changes in this version

+ func CellToChildPos(a Cell, resolution int) int

type Cell

+ func ChildPosToCell(position int, a Cell, resolution int) Cell

+ func (c Cell) ChildPos(resolution int) int

+ func (c Cell) ChildPosToCell(position int, resolution int) Cell

v4.0.1

Sep 30, 2022

v4.0.0

Sep 8, 2022

Changes in this version

+ const DegsToRads

+ const InvalidH3Index

+ const MaxCellBndryVerts

+ const MaxResolution

+ const NumBaseCells

+ const NumIcosaFaces

+ const NumPentagons

+ const RadsToDegs

+ func BaseCellNumber(h Cell) int

+ func CellAreaKm2(c Cell) float64

+ func CellAreaM2(c Cell) float64

+ func CellAreaRads2(c Cell) float64

+ func EdgeLengthKm(e DirectedEdge) float64

+ func EdgeLengthM(e DirectedEdge) float64

+ func EdgeLengthRads(e DirectedEdge) float64

+ func GreatCircleDistanceKm(a, b LatLng) float64

+ func GreatCircleDistanceM(a, b LatLng) float64

+ func GreatCircleDistanceRads(a, b LatLng) float64

+ func GridDiskDistances(origin Cell, k int) [][]Cell

+ func GridDistance(a, b Cell) int

+ func HexagonAreaAvgKm2(resolution int) float64

+ func HexagonAreaAvgM2(resolution int) float64

+ func HexagonEdgeLengthAvgKm(resolution int) float64

+ func HexagonEdgeLengthAvgM(resolution int) float64

+ func IndexFromString(s string) uint64

+ func IndexToString(i uint64) string

+ func NumCells(resolution int) int

+ type Cell int64

+ func CompactCells(in []Cell) []Cell

+ func GridDisk(origin Cell, k int) []Cell

+ func GridPath(a, b Cell) []Cell

+ func LatLngToCell(latLng LatLng, resolution int) Cell

+ func LocalIJToCell(origin Cell, ij CoordIJ) Cell

+ func Pentagons(resolution int) []Cell

+ func PolygonToCells(polygon GeoPolygon, resolution int) []Cell

+ func Res0Cells() []Cell

+ func UncompactCells(in []Cell, resolution int) []Cell

+ func (c *Cell) UnmarshalText(text []byte) error

+ func (c Cell) BaseCellNumber() int

+ func (c Cell) Boundary() CellBoundary

+ func (c Cell) CenterChild(resolution int) Cell

+ func (c Cell) Children(resolution int) []Cell

+ func (c Cell) DirectedEdge(other Cell) DirectedEdge

+ func (c Cell) DirectedEdges() []DirectedEdge

+ func (c Cell) GridDisk(k int) []Cell

+ func (c Cell) GridDiskDistances(k int) [][]Cell

+ func (c Cell) GridDistance(other Cell) int

+ func (c Cell) GridPath(other Cell) []Cell

+ func (c Cell) IcosahedronFaces() []int

+ func (c Cell) ImmediateChildren() []Cell

+ func (c Cell) ImmediateParent() Cell

+ func (c Cell) IsNeighbor(other Cell) bool

+ func (c Cell) IsPentagon() bool

+ func (c Cell) IsResClassIII() bool

+ func (c Cell) IsValid() bool

+ func (c Cell) LatLng() LatLng

+ func (c Cell) MarshalText() ([]byte, error)

+ func (c Cell) Parent(resolution int) Cell

+ func (c Cell) Resolution() int

+ func (c Cell) String() string

+ type CellBoundary []LatLng

+ func CellToBoundary(c Cell) CellBoundary

+ type CoordIJ struct

+ I int

+ J int

+ func CellToLocalIJ(origin, cell Cell) CoordIJ

+ type DirectedEdge int64

+ func (e DirectedEdge) Boundary() CellBoundary

+ func (e DirectedEdge) Cells() []Cell

+ func (e DirectedEdge) Destination() Cell

+ func (e DirectedEdge) IsValid() bool

+ func (e DirectedEdge) Origin() Cell

+ func (e DirectedEdge) Resolution() int

+ type GeoLoop []LatLng

+ type GeoPolygon struct

+ GeoLoop GeoLoop

+ Holes []GeoLoop

+ func (p GeoPolygon) Cells(resolution int) []Cell

+ type LatLng struct

+ Lat float64

+ Lng float64

+ func CellToLatLng(c Cell) LatLng

+ func NewLatLng(lat, lng float64) LatLng

+ func (g LatLng) Cell(resolution int) Cell

+ func (g LatLng) String() string

+ type LinkedGeoPolygon struct

+ func CellsToMultiPolygon(cells []Cell) *LinkedGeoPolygon

Other modules containing this package

github.com/uber/h3-go

github.com/uber/h3-go/v3

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL