1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
/*
* 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.
*/
/** @file h3Index.h
* @brief H3Index functions.
*/
#ifndef H3INDEX_H
#define H3INDEX_H
#include "faceijk.h"
#include "h3api.h"
// define's of constants and macros for bitwise manipulation of H3Index's.
/** The number of bits in an H3 index. */
#define H3_NUM_BITS 64
/** The bit offset of the max resolution digit in an H3 index. */
#define H3_MAX_OFFSET 63
/** The bit offset of the mode in an H3 index. */
#define H3_MODE_OFFSET 59
/** The bit offset of the base cell in an H3 index. */
#define H3_BC_OFFSET 45
/** The bit offset of the resolution in an H3 index. */
#define H3_RES_OFFSET 52
/** The bit offset of the reserved bits in an H3 index. */
#define H3_RESERVED_OFFSET 56
/** The number of bits in a single H3 resolution digit. */
#define H3_PER_DIGIT_OFFSET 3
/** 1 in the highest bit, 0's everywhere else. */
#define H3_HIGH_BIT_MASK ((uint64_t)(1) << H3_MAX_OFFSET)
/** 0 in the highest bit, 1's everywhere else. */
#define H3_HIGH_BIT_MASK_NEGATIVE (~H3_HIGH_BIT_MASK)
/** 1's in the 4 mode bits, 0's everywhere else. */
#define H3_MODE_MASK ((uint64_t)(15) << H3_MODE_OFFSET)
/** 0's in the 4 mode bits, 1's everywhere else. */
#define H3_MODE_MASK_NEGATIVE (~H3_MODE_MASK)
/** 1's in the 7 base cell bits, 0's everywhere else. */
#define H3_BC_MASK ((uint64_t)(127) << H3_BC_OFFSET)
/** 0's in the 7 base cell bits, 1's everywhere else. */
#define H3_BC_MASK_NEGATIVE (~H3_BC_MASK)
/** 1's in the 4 resolution bits, 0's everywhere else. */
#define H3_RES_MASK (UINT64_C(15) << H3_RES_OFFSET)
/** 0's in the 4 resolution bits, 1's everywhere else. */
#define H3_RES_MASK_NEGATIVE (~H3_RES_MASK)
/** 1's in the 3 reserved bits, 0's everywhere else. */
#define H3_RESERVED_MASK ((uint64_t)(7) << H3_RESERVED_OFFSET)
/** 0's in the 3 reserved bits, 1's everywhere else. */
#define H3_RESERVED_MASK_NEGATIVE (~H3_RESERVED_MASK)
/** 1's in the 3 bits of res 15 digit bits, 0's everywhere else. */
#define H3_DIGIT_MASK ((uint64_t)(7))
/** 0's in the 7 base cell bits, 1's everywhere else. */
#define H3_DIGIT_MASK_NEGATIVE (~H3_DIGIT_MASK)
/**
* H3 index with mode 0, res 0, base cell 0, and 7 for all index digits.
* Typically used to initialize the creation of an H3 cell index, which
* expects all direction digits to be 7 beyond the cell's resolution.
*/
#define H3_INIT (UINT64_C(35184372088831))
/**
* Gets the highest bit of the H3 index.
*/
#define H3_GET_HIGH_BIT(h3) ((int)((((h3)&H3_HIGH_BIT_MASK) >> H3_MAX_OFFSET)))
/**
* Sets the highest bit of the h3 to v.
*/
#define H3_SET_HIGH_BIT(h3, v) \
(h3) = (((h3)&H3_HIGH_BIT_MASK_NEGATIVE) | \
(((uint64_t)(v)) << H3_MAX_OFFSET))
/**
* Gets the integer mode of h3.
*/
#define H3_GET_MODE(h3) ((int)((((h3)&H3_MODE_MASK) >> H3_MODE_OFFSET)))
/**
* Sets the integer mode of h3 to v.
*/
#define H3_SET_MODE(h3, v) \
(h3) = (((h3)&H3_MODE_MASK_NEGATIVE) | (((uint64_t)(v)) << H3_MODE_OFFSET))
/**
* Gets the integer base cell of h3.
*/
#define H3_GET_BASE_CELL(h3) ((int)((((h3)&H3_BC_MASK) >> H3_BC_OFFSET)))
/**
* Sets the integer base cell of h3 to bc.
*/
#define H3_SET_BASE_CELL(h3, bc) \
(h3) = (((h3)&H3_BC_MASK_NEGATIVE) | (((uint64_t)(bc)) << H3_BC_OFFSET))
/**
* Gets the integer resolution of h3.
*/
#define H3_GET_RESOLUTION(h3) ((int)((((h3)&H3_RES_MASK) >> H3_RES_OFFSET)))
/**
* Sets the integer resolution of h3.
*/
#define H3_SET_RESOLUTION(h3, res) \
(h3) = (((h3)&H3_RES_MASK_NEGATIVE) | (((uint64_t)(res)) << H3_RES_OFFSET))
/**
* Gets the resolution res integer digit (0-7) of h3.
*/
#define H3_GET_INDEX_DIGIT(h3, res) \
((Direction)((((h3) >> ((MAX_H3_RES - (res)) * H3_PER_DIGIT_OFFSET)) & \
H3_DIGIT_MASK)))
/**
* Sets a value in the reserved space. Setting to non-zero may produce invalid
* indexes.
*/
#define H3_SET_RESERVED_BITS(h3, v) \
(h3) = (((h3)&H3_RESERVED_MASK_NEGATIVE) | \
(((uint64_t)(v)) << H3_RESERVED_OFFSET))
/**
* Gets a value in the reserved space. Should always be zero for valid indexes.
*/
#define H3_GET_RESERVED_BITS(h3) \
((int)((((h3)&H3_RESERVED_MASK) >> H3_RESERVED_OFFSET)))
/**
* Sets the resolution res digit of h3 to the integer digit (0-7)
*/
#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)))
/**
* Invalid index used to indicate an error from geoToH3 and related functions
* or missing data in arrays of h3 indices. Analogous to NaN in floating point.
*/
#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);
int isResClassIII(int res);
// Internal functions
int _h3ToFaceIjkWithInitializedFijk(H3Index h, FaceIJK* fijk);
void _h3ToFaceIjk(H3Index h, FaceIJK* fijk);
H3Index _faceIjkToH3(const FaceIJK* fijk, int res);
Direction _h3LeadingNonZeroDigit(H3Index h);
H3Index _h3RotatePent60ccw(H3Index h);
H3Index _h3RotatePent60cw(H3Index h);
H3Index _h3Rotate60ccw(H3Index h);
H3Index _h3Rotate60cw(H3Index h);
#endif
|
