h3Index.h

Go to the documentation of this file.

/*
 * Copyright 2016-2018 Uber Technologies, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#ifndef H3INDEX_H
#define H3INDEX_H

#include "QueryEngine/ExtensionFunctions/h3lib/include/faceijk.h"
#include "QueryEngine/ExtensionFunctions/h3lib/include/h3api.h"

// define's of constants and macros for bitwise manipulation of H3Index's.

#define H3_NUM_BITS 64

#define H3_MAX_OFFSET 63

#define H3_MODE_OFFSET 59

#define H3_BC_OFFSET 45

// /** The bit offset of the resolution in an H3 index. */
#define H3_RES_OFFSET 52

#define H3_RESERVED_OFFSET 56

#define H3_PER_DIGIT_OFFSET 3

#define H3_HIGH_BIT_MASK ((uint64_t)(1) << H3_MAX_OFFSET)

#define H3_HIGH_BIT_MASK_NEGATIVE (~H3_HIGH_BIT_MASK)

#define H3_MODE_MASK ((uint64_t)(15) << H3_MODE_OFFSET)

#define H3_MODE_MASK_NEGATIVE (~H3_MODE_MASK)

#define H3_BC_MASK ((uint64_t)(127) << H3_BC_OFFSET)

#define H3_BC_MASK_NEGATIVE (~H3_BC_MASK)

#define H3_RES_MASK (UINT64_C(15) << H3_RES_OFFSET)

#define H3_RES_MASK_NEGATIVE (~H3_RES_MASK)

#define H3_RESERVED_MASK ((uint64_t)(7) << H3_RESERVED_OFFSET)

#define H3_RESERVED_MASK_NEGATIVE (~H3_RESERVED_MASK)

#define H3_DIGIT_MASK ((uint64_t)(7))

#define H3_DIGIT_MASK_NEGATIVE (~H3_DIGIT_MASK)

#define H3_INIT (UINT64_C(35184372088831))

#define H3_GET_HIGH_BIT(h3) ((int)((((h3)&H3_HIGH_BIT_MASK) >> H3_MAX_OFFSET)))

#define H3_SET_HIGH_BIT(h3, v) \
  (h3) = (((h3)&H3_HIGH_BIT_MASK_NEGATIVE) | (((uint64_t)(v)) << H3_MAX_OFFSET))

#define H3_GET_MODE(h3) ((int)((((h3)&H3_MODE_MASK) >> H3_MODE_OFFSET)))

#define H3_SET_MODE(h3, v) \
  (h3) = (((h3)&H3_MODE_MASK_NEGATIVE) | (((uint64_t)(v)) << H3_MODE_OFFSET))

#define H3_GET_BASE_CELL(h3) ((int)((((h3)&H3_BC_MASK) >> H3_BC_OFFSET)))

#define H3_SET_BASE_CELL(h3, bc) \
  (h3) = (((h3)&H3_BC_MASK_NEGATIVE) | (((uint64_t)(bc)) << H3_BC_OFFSET))

#define H3_GET_RESOLUTION(h3) ((int)((((h3)&H3_RES_MASK) >> H3_RES_OFFSET)))

#define H3_SET_RESOLUTION(h3, res) \
  (h3) = (((h3)&H3_RES_MASK_NEGATIVE) | (((uint64_t)(res)) << H3_RES_OFFSET))

#define H3_GET_INDEX_DIGIT(h3, res) \
  ((Direction)((((h3) >> ((MAX_H3_RES - (res)) * H3_PER_DIGIT_OFFSET)) & H3_DIGIT_MASK)))

#define H3_SET_RESERVED_BITS(h3, v) \
  (h3) = (((h3)&H3_RESERVED_MASK_NEGATIVE) | (((uint64_t)(v)) << H3_RESERVED_OFFSET))

#define H3_GET_RESERVED_BITS(h3) ((int)((((h3)&H3_RESERVED_MASK) >> H3_RESERVED_OFFSET)))

#define H3_SET_INDEX_DIGIT(h3, res, digit)                                              \
  (h3) = (((h3) & ~((H3_DIGIT_MASK << ((MAX_H3_RES - (res)) * H3_PER_DIGIT_OFFSET)))) | \
          (((uint64_t)(digit)) << ((MAX_H3_RES - (res)) * H3_PER_DIGIT_OFFSET)))

#define H3_NULL 0

/*
 * Return codes for compact
 */

#define COMPACT_SUCCESS 0
#define COMPACT_LOOP_EXCEEDED -1
#define COMPACT_DUPLICATE -2
#define COMPACT_ALLOC_FAILED -3

// void setH3Index(H3Index* h, int res, int baseCell, Direction initDigit);

// Internal functions

// int _h3ToFaceIjkWithInitializedFijk(H3Index h, FaceIJK* fijk);
// void _h3ToFaceIjk(H3Index h, FaceIJK* fijk);
EXTENSION_NOINLINE H3Index _faceIjkToH3(const FaceIJK(fijk), int res);
EXTENSION_INLINE int _h3LeadingNonZeroDigit(H3Index h);
EXTENSION_NOINLINE H3Index _h3RotatePent60ccw(H3Index h);
EXTENSION_NOINLINE H3Index _h3RotatePent60cw(H3Index h);
EXTENSION_NOINLINE H3Index _h3Rotate60ccw(H3Index h);
EXTENSION_NOINLINE H3Index _h3Rotate60cw(H3Index h);
EXTENSION_NOINLINE int _h3ToFaceIjkWithInitializedFijk(H3Index h, FaceIJK(fijk));
EXTENSION_NOINLINE bool _h3ToFaceIjk(H3Index h, FaceIJK(fijk));
EXTENSION_NOINLINE bool _h3ToGeo(H3Index h3, GeoCoord(g));

#include "QueryEngine/ExtensionFunctions/h3lib/lib/h3Index.hpp"

#endif