OmniSciDB  6686921089
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
h3api.h File Reference

Primary H3 core library entry points. More...

#include <cmath>
#include "QueryEngine/OmniSciTypes.h"
#include <stdint.h>
+ Include dependency graph for h3api.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define H3_EXPORT(name)   name
 
#define H3Index   int64_t
 the H3Index fits within a 64-bit unsigned integer More...
 
#define LAT_INDEX   0
 
#define LON_INDEX   1
 
#define GeoCoord(variable_name)   double variable_name[2]
 
#define GeoCoordArray(variable_name, size)   double variable_name[size][2]
 
#define GeoCoordCopy(dest_coord, src_coord)
 

Functions

EXTENSION_NOINLINE H3Index
H3_EXPORT() 
geoToH3 (const double lon, const double lat, int res)
 find the H3 index of the resolution res cell containing the lat/lng More...
 
EXTENSION_NOINLINE int64_t
H3_EXPORT() 
h3ToGeoPacked (H3Index h3)
 find the lat/lon center point g of the cell h3 More...
 
EXTENSION_NOINLINE double
H3_EXPORT() 
h3ToLon (H3Index h3)
 
EXTENSION_NOINLINE double
H3_EXPORT() 
h3ToLat (H3Index h3)
 
EXTENSION_INLINE double H3_EXPORT() degsToRads (double degrees)
 converts degrees to radians More...
 
EXTENSION_INLINE double H3_EXPORT() radsToDegs (double radians)
 converts radians to degrees More...
 
EXTENSION_NOINLINE H3Index
H3_EXPORT() 
h3ToParent (H3Index h, int parentRes)
 returns the parent (or grandparent, etc) hexagon of the given hexagon More...
 

Detailed Description

Primary H3 core library entry points.

This file defines the public API of the H3 library. Incompatible changes to these functions require the library's major version be increased.

Definition in file h3api.h.

Macro Definition Documentation

#define GeoCoord (   variable_name)    double variable_name[2]

Definition at line 94 of file h3api.h.

Referenced by geoToH3(), h3ToGeoPacked(), h3ToLat(), and h3ToLon().

#define GeoCoordArray (   variable_name,
  size 
)    double variable_name[size][2]

Definition at line 95 of file h3api.h.

#define GeoCoordCopy (   dest_coord,
  src_coord 
)
Value:
dest_coord[LAT_INDEX] = src_coord[LAT_INDEX]; \
dest_coord[LON_INDEX] = src_coord[LON_INDEX];
#define LAT_INDEX
Definition: h3api.h:92
#define LON_INDEX
Definition: h3api.h:93

Definition at line 96 of file h3api.h.

Referenced by _geoAzDistanceRads(), and _hex2dToGeo().

#define H3_EXPORT (   name)    name

Definition at line 43 of file h3api.h.

#define H3Index   int64_t

the H3Index fits within a 64-bit unsigned integer

Definition at line 75 of file h3api.h.

Referenced by _faceIjkToH3(), and h3ToParent().

#define LAT_INDEX   0

Definition at line 92 of file h3api.h.

Referenced by _geoAzDistanceRads(), _geoAzimuthRads(), _geoToVec3d(), h3ToGeoPacked(), and h3ToLat().

#define LON_INDEX   1

Definition at line 93 of file h3api.h.

Referenced by _geoAzDistanceRads(), _geoAzimuthRads(), _geoToVec3d(), h3ToGeoPacked(), and h3ToLon().