h3-hs-0.2.0.0: A Haskell binding for H3
Safe HaskellSafe-Inferred
LanguageHaskell2010

H3.Data

Description

This module collects the data types provided by the H3 API.

Synopsis

Documentation

data LatLng Source #

Latitude and longitude in radians

Constructors

LatLng 

Fields

Instances

Instances details
Storable LatLng Source # 
Instance details

Defined in H3.Internal.H3Api

Methods

sizeOf :: LatLng -> Int #

alignment :: LatLng -> Int #

peekElemOff :: Ptr LatLng -> Int -> IO LatLng #

pokeElemOff :: Ptr LatLng -> Int -> LatLng -> IO () #

peekByteOff :: Ptr b -> Int -> IO LatLng #

pokeByteOff :: Ptr b -> Int -> LatLng -> IO () #

peek :: Ptr LatLng -> IO LatLng #

poke :: Ptr LatLng -> LatLng -> IO () #

Show LatLng Source # 
Instance details

Defined in H3.Internal.H3Api

Methods

showsPrec :: Int -> LatLng -> ShowS #

show :: LatLng -> String #

showList :: [LatLng] -> ShowS #

Eq LatLng Source # 
Instance details

Defined in H3.Internal.H3Api

Methods

(==) :: LatLng -> LatLng -> Bool #

(/=) :: LatLng -> LatLng -> Bool #

type H3Index = Word64 Source #

H3Index is a type synonym for Word64, which we use as the numeric representation of the H3 index in Haskell

The C H3 error codes are modeled as a Haskell data type and instance of Enum

data H3ErrorCodes Source #

Constructors

E_SUCCESS 
E_FAILED 
E_DOMAIN 
E_LATLNG_DOMAIN 
E_RES_DOMAIN 
E_CELL_INVALID 
E_DIR_EDGE_INVALID 
E_UNDIR_EDGE_INVALID 
E_VERTEX_INVALID 
E_PENTAGON 
E_DUPLICATE_INPUT 
E_NOT_NEIGHBORS 
E_RES_MISMATCH 
E_MEMORY_ALLOC 
E_MEMORY_BOUNDS 
E_OPTION_INVALID 

Instances

Instances details
Enum H3ErrorCodes Source # 
Instance details

Defined in H3.Internal.H3Api

Methods

succ :: H3ErrorCodes -> H3ErrorCodes #

pred :: H3ErrorCodes -> H3ErrorCodes #

toEnum :: Int -> H3ErrorCodes #

fromEnum :: H3ErrorCodes -> Int #

enumFrom :: H3ErrorCodes -> [H3ErrorCodes] #

enumFromThen :: H3ErrorCodes -> H3ErrorCodes -> [H3ErrorCodes] #

enumFromTo :: H3ErrorCodes -> H3ErrorCodes -> [H3ErrorCodes] #

enumFromThenTo :: H3ErrorCodes -> H3ErrorCodes -> H3ErrorCodes -> [H3ErrorCodes] #

Show H3ErrorCodes Source # 
Instance details

Defined in H3.Internal.H3Api

Methods

showsPrec :: Int -> H3ErrorCodes -> ShowS #

show :: H3ErrorCodes -> String #

showList :: [H3ErrorCodes] -> ShowS #

Eq H3ErrorCodes Source # 
Instance details

Defined in H3.Internal.H3Api

Methods

(==) :: H3ErrorCodes -> H3ErrorCodes -> Bool #

(/=) :: H3ErrorCodes -> H3ErrorCodes -> Bool #

type GeoLoop = [LatLng] Source #

A GeoLoop is defined as a list of LatLng in Haskell

data GeoPolygon Source #

A GeoPolygon has an exterior and interior holes, the exterior and each interior hole being a GeoLoop

Constructors

GeoPolygon GeoLoop [GeoLoop] 

Instances

Instances details
Show GeoPolygon Source # 
Instance details

Defined in H3.Internal.H3Api

Methods

showsPrec :: Int -> GeoPolygon -> ShowS #

show :: GeoPolygon -> String #

showList :: [GeoPolygon] -> ShowS #

Eq GeoPolygon Source # 
Instance details

Defined in H3.Internal.H3Api

Methods

(==) :: GeoPolygon -> GeoPolygon -> Bool #

(/=) :: GeoPolygon -> GeoPolygon -> Bool #

data CoordIJ Source #

Hexagon coordinates

Constructors

CoordIJ Int Int 

Instances

Instances details
Storable CoordIJ Source # 
Instance details

Defined in H3.Internal.H3Api

Methods

sizeOf :: CoordIJ -> Int #

alignment :: CoordIJ -> Int #

peekElemOff :: Ptr CoordIJ -> Int -> IO CoordIJ #

pokeElemOff :: Ptr CoordIJ -> Int -> CoordIJ -> IO () #

peekByteOff :: Ptr b -> Int -> IO CoordIJ #

pokeByteOff :: Ptr b -> Int -> CoordIJ -> IO () #

peek :: Ptr CoordIJ -> IO CoordIJ #

poke :: Ptr CoordIJ -> CoordIJ -> IO () #

Show CoordIJ Source # 
Instance details

Defined in H3.Internal.H3Api

Methods

showsPrec :: Int -> CoordIJ -> ShowS #

show :: CoordIJ -> String #

showList :: [CoordIJ] -> ShowS #

Eq CoordIJ Source # 
Instance details

Defined in H3.Internal.H3Api

Methods

(==) :: CoordIJ -> CoordIJ -> Bool #

(/=) :: CoordIJ -> CoordIJ -> Bool #