| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
H3.Inspection
Description
These functions provide metadata about an H3 index, such as its resolution or base cell, and provide utilities for converting into and out of the 64-bit representation of an H3 index.
Synopsis
- getResolution :: H3Index -> Int
- getBaseCellNumber :: H3Index -> Int
- stringToH3 :: String -> Either H3ErrorCodes H3Index
- h3ToString :: H3Index -> Either H3ErrorCodes String
- isValidCell :: H3Index -> Int
- isResClassIII :: H3Index -> Int
- isPentagon :: H3Index -> Int
- getIcosahedronFaces :: H3Index -> Either H3ErrorCodes [Int]
Documentation
getResolution :: H3Index -> Int Source #
Returns the resolution of the index.
getBaseCellNumber :: H3Index -> Int Source #
Returns the base cell number of the index.
stringToH3 :: String -> Either H3ErrorCodes H3Index Source #
Converts the string representation to the H3Index (Word64) representation.
h3ToString :: H3Index -> Either H3ErrorCodes String Source #
Converts the H3Index representation to the string representation.
isValidCell :: H3Index -> Int Source #
isValidCell returns non-zero if this is a valid H3 cell index
isResClassIII :: H3Index -> Int Source #
Returns non-zero if this index has a resolution with Class III orientation.
isPentagon :: H3Index -> Int Source #
Returns non-zero if this index represents a pentagonal cell.
getIcosahedronFaces :: H3Index -> Either H3ErrorCodes [Int] Source #
Return all icosahedron faces intersected by a given H3 index. Faces are represented as integers from 0-19, inclusive. The array is sparse, and empty (no intersection) array values are represented by -1.