bump core lib to 4.0 rc5

CHANGELOG.md

@@ -65,7 +65,7 @@ avoid adding features or APIs which do not map onto the
 
 ## [3.6.2] - 2020-06-02
 
-- Improve error reporting on `hex2int` (https:/uber/h3-py/pull/127)
+- Improve error reporting on `str_to_int` (https:/uber/h3-py/pull/127)
 - Build Linux wheels for Python 2.7
 
 ## [3.6.1] - 2020-05-29

docs/api_comparison.md

@@ -37,7 +37,7 @@ needs, based on speed and convenience.
 
 ```{tip}
 Note that the APIs are all 100% compatible, and it is easy to convert
-between them with functions like `int_to_string` (links!) and `string_to_int`.
+between them with functions like `int_to_str` (links!) and `str_to_int`.
 
 For example, one common pattern is to use `h3.api.numpy_int` for any
 computationally-heavy work, and convert the output to `str` and `list`/`set`
@@ -236,7 +236,7 @@ def compute(h3_lib, N=100):
 
 def compute_and_convert(h3_lib, N=100):
  out = compute(h3_lib, N)
- out = [h3.int_to_string(h) for h in out]
+ out = [h3.int_to_str(h) for h in out]
 
  return out
 ```

docs/api_reference.md

@@ -34,8 +34,8 @@ but we'll try to group functions in a reasonably logical manner.
 .. autosummary::
  latlng_to_cell
  cell_to_latlng
- int_to_string
- string_to_int
+ int_to_str
+ str_to_int
  get_res0_cells
  get_pentagons
  get_num_cells

src/h3/_cy/__init__.py

@@ -67,8 +67,8 @@
 
 from .util import (
  c_version,
- hex2int,
- int2hex,
+ str_to_int,
+ int_to_str,
 )
 
 from .memory import (

src/h3/_cy/edges.pyx

@@ -101,11 +101,11 @@ cpdef double edge_length(H3int e, unit='km') except -1:
  double length
 
  if unit == 'rads':
- err = h3lib.exactEdgeLengthRads(e, &length)
+ err = h3lib.edgeLengthRads(e, &length)
  elif unit == 'km':
- err = h3lib.exactEdgeLengthKm(e, &length)
+ err = h3lib.edgeLengthKm(e, &length)
  elif unit == 'm':
- err = h3lib.exactEdgeLengthM(e, &length)
+ err = h3lib.edgeLengthM(e, &length)
  else:
  raise ValueError('Unknown unit: {}'.format(unit))
 

src/h3/_cy/error_system.pyx

@@ -84,7 +84,7 @@ from .h3lib cimport (
  E_DUPLICATE_INPUT,
  E_NOT_NEIGHBORS,
  E_RES_MISMATCH,
- E_MEMORY,
+ E_MEMORY_ALLOC,
  E_MEMORY_BOUNDS,
  E_OPTION_INVALID,
 )
@@ -189,7 +189,7 @@ error_mapping = {
  E_DUPLICATE_INPUT: H3DuplicateInputError,
  E_NOT_NEIGHBORS: H3NotNeighborsError,
  E_RES_MISMATCH: H3ResMismatchError,
- E_MEMORY:  H3MemoryAllocError,
+ E_MEMORY_ALLOC: H3MemoryAllocError,
  E_MEMORY_BOUNDS: H3MemoryBoundsError,
  E_OPTION_INVALID: H3OptionInvalidError,
 }

src/h3/_cy/geo.pyx

@@ -291,11 +291,11 @@ cpdef double great_circle_distance(
  b = deg2coord(lat2, lng2)
 
  if unit == 'rads':
- d = h3lib.distanceRads(&a, &b)
+ d = h3lib.greatCircleDistanceRads(&a, &b)
  elif unit == 'km':
- d = h3lib.distanceKm(&a, &b)
+ d = h3lib.greatCircleDistanceKm(&a, &b)
  elif unit == 'm':
- d = h3lib.distanceM(&a, &b)
+ d = h3lib.greatCircleDistanceM(&a, &b)
  else:
  raise ValueError('Unknown unit: {}'.format(unit))
 

src/h3/_cy/h3lib.pxd

@@ -25,7 +25,7 @@ cdef extern from 'h3api.h':
  E_DUPLICATE_INPUT = 10
  E_NOT_NEIGHBORS = 11
  E_RES_MISMATCH = 12
- E_MEMORY = 13
+ E_MEMORY_ALLOC = 13
  E_MEMORY_BOUNDS = 14
  E_OPTION_INVALID = 15
 
@@ -143,16 +143,16 @@ cdef extern from 'h3api.h':
  H3Error getHexagonEdgeLengthAvgKm(int res, double *out) nogil
  H3Error getHexagonEdgeLengthAvgM(int res, double *out) nogil
 
- H3Error exactEdgeLengthRads(H3int edge, double *out) nogil
- H3Error exactEdgeLengthKm(H3int edge, double *out) nogil
- H3Error exactEdgeLengthM(H3int edge, double *out) nogil
+ H3Error edgeLengthRads(H3int edge, double *out) nogil
+ H3Error edgeLengthKm(H3int edge, double *out) nogil
+ H3Error edgeLengthM(H3int edge, double *out) nogil
 
  H3Error cellToBoundary(H3int h3, CellBoundary *gp) nogil
  H3Error directedEdgeToBoundary(H3int edge, CellBoundary *gb) nogil
 
- double distanceRads(const LatLng *a, const LatLng *b) nogil
- double distanceKm(const LatLng *a, const LatLng *b) nogil
- double distanceM(const LatLng *a, const LatLng *b) nogil
+ double greatCircleDistanceRads(const LatLng *a, const LatLng *b) nogil
+ double greatCircleDistanceKm(const LatLng *a, const LatLng *b) nogil
+ double greatCircleDistanceM(const LatLng *a, const LatLng *b) nogil
 
  H3Error cellsToLinkedMultiPolygon(const H3int *h3Set, const int numHexes, LinkedGeoPolygon *out)
  void destroyLinkedMultiPolygon(LinkedGeoPolygon *polygon)

src/h3/_cy/util.pxd

@@ -3,8 +3,8 @@ from .h3lib cimport H3int, H3str, LatLng
 cdef LatLng deg2coord(double lat, double lng) nogil
 cdef (double, double) coord2deg(LatLng c) nogil
 
-cpdef H3int hex2int(H3str h) except? 0
-cpdef H3str int2hex(H3int x)
+cpdef H3int str_to_int(H3str h) except? 0
+cpdef H3str int_to_str(H3int x)
 
 cdef check_cell(H3int h)
 cdef check_edge(H3int e)

src/h3/_cy/util.pyx

@@ -36,11 +36,11 @@ cpdef basestring c_version():
  return '{}.{}.{}'.format(*v)
 
 
-cpdef H3int hex2int(H3str h) except? 0:
+cpdef H3int str_to_int(H3str h) except? 0:
  return int(h, 16)
 
 
-cpdef H3str int2hex(H3int x):
+cpdef H3str int_to_str(H3int x):
  """ Convert H3 integer to hex string representation
 
  Need to be careful in Python 2 because `hex(x)` may return a string
@@ -61,7 +61,7 @@ cdef check_cell(H3int h):
  we want the error message to be informative to the user
  in either case.
 
- We use the builtin `hex` function instead of `int2hex` to
+ We use the builtin `hex` function instead of `int_to_str` to
  prepend `0x` to indicate that this **integer** representation
  is incorrect, but in a format that is easily compared to
  `str` inputs.

src/h3/api/_api_template.py

@@ -78,7 +78,7 @@ def versions():
  return v
 
  @staticmethod
- def string_to_int(h):
+ def str_to_int(h):
  """
  Converts a hexadecimal string to an H3 64-bit integer index.
 
@@ -92,10 +92,10 @@ def string_to_int(h):
  int
  Unsigned 64-bit integer
  """
- return _cy.hex2int(h)
+ return _cy.str_to_int(h)
 
  @staticmethod
- def int_to_string(x):
+ def int_to_str(x):
  """
  Converts an H3 64-bit integer index to a hexadecimal string.
 
@@ -109,7 +109,7 @@ def int_to_string(x):
  str
  Hexadecimal string like ``'89754e64993ffff'``
  """
- return _cy.int2hex(x)
+ return _cy.int_to_str(x)
 
  @staticmethod
  def get_num_cells(resolution):
@@ -887,35 +887,31 @@ def edge_length(self, e, unit='km'):
  return _cy.edge_length(e, unit=unit)
 
  @staticmethod
- def great_circle_distance(point1, point2, unit='km'):
+ def great_circle_distance(latlng1, latlng2, unit='km'):
  """
  Compute the spherical distance between two (lat, lng) points.
-
- todo: do we handle lat/lng points consistently in the api? what
- about (lat1, lng1, lat2, lng2) as the input? How will this work
- for vectorized versions?
+ AKA: great circle distance or "haversine" distance.
 
  todo: overload to allow two cell inputs?
 
  Parameters
  ----------
- point1 : tuple
+ latlng1 : tuple
  (lat, lng) tuple in degrees
- point2 : tuple
+ latlng2 : tuple
  (lat, lng) tuple in degrees
  unit: str
  Unit for distance result ('km', 'm', or 'rads')
 
 
  Returns
  -------
- Spherical (or "haversine") distance between the points
+ The spherical distance between the points in the given units
  """
- lat1, lng1 = point1
- lat2, lng2 = point2
-
+ lat1, lng1 = latlng1
+ lat2, lng2 = latlng2
  return _cy.great_circle_distance(
  lat1, lng1,
  lat2, lng2,
- unit=unit
+ unit = unit
  )

src/h3/api/basic_int/_public_api.py

@@ -14,8 +14,8 @@
 is_valid_directed_edge = _b.is_valid_directed_edge
 is_res_class_III = _b.is_res_class_III
 
-int_to_string = _b.int_to_string
-string_to_int = _b.string_to_int
+int_to_str = _b.int_to_str
+str_to_int = _b.str_to_int
 
 cell_area = _b.cell_area
 edge_length = _b.edge_length

src/h3/api/basic_str/_binding.py

@@ -19,24 +19,24 @@
 
 
 def _in_collection(hexes):
- it = [_cy.hex2int(h) for h in hexes]
+ it = [_cy.str_to_int(h) for h in hexes]
 
  return _cy.iter_to_mv(it)
 
 
 def _out_unordered(mv):
  # todo: should this be an (immutable) frozenset?
- return set(_cy.int2hex(h) for h in mv)
+ return set(_cy.int_to_str(h) for h in mv)
 
 
 def _out_ordered(mv):
  # todo: should this be an (immutable) tuple?
- return list(_cy.int2hex(h) for h in mv)
+ return list(_cy.int_to_str(h) for h in mv)
 
 
 _binding = _API_FUNCTIONS(
- _in_scalar = _cy.hex2int,
- _out_scalar = _cy.int2hex,
+ _in_scalar = _cy.str_to_int,
+ _out_scalar = _cy.int_to_str,
  _in_collection = _in_collection,
  _out_unordered = _out_unordered,
  _out_ordered = _out_ordered,

tests/test_cells_and_edges.py

@@ -151,7 +151,7 @@ def test_parent_err():
 
  # todo: revist this weird formatting stuff
  expected = 'Invalid parent resolution -1 for cell {}.'
- expected = expected.format(hex(h3.string_to_int(h)))
+ expected = expected.format(hex(h3.str_to_int(h)))
 
  assert msg == expected
 
@@ -480,12 +480,12 @@ def test_versions():
 
 def test_str_int_convert():
  s = '8928308280fffff'
- i = h3.string_to_int(s)
+ i = h3.str_to_int(s)
 
- assert h3.int_to_string(i) == s
+ assert h3.int_to_str(i) == s
 
 
-def test_hex2int_fail():
+def test_str_to_int_fail():
  h_invalid = {}
 
  assert not h3.is_valid_cell(h_invalid)

tests/test_memview_int.py

@@ -9,7 +9,7 @@ def test1():
 def test_line():
  h1 = '8928308280fffff'
  h2 = '8928308287bffff'
- h1, h2 = h3.string_to_int(h1), h3.string_to_int(h2)
+ h1, h2 = h3.str_to_int(h1), h3.str_to_int(h2)
 
  out = h3.grid_path_cells(h1, h2)