-
Notifications
You must be signed in to change notification settings - Fork 10
/
H3Lib.xml
4614 lines (4543 loc) · 183 KB
/
H3Lib.xml
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>H3Lib</name>
</assembly>
<members>
<member name="T:H3Lib.Api">
<summary>
Primary H3 core library entry points.
</summary>
</member>
<member name="M:H3Lib.Api.GeoToH3(H3Lib.GeoCoord,System.Int32)">
<summary>
find the H3 index of the resolution res cell containing the lat/lng
</summary>
</member>
<member name="M:H3Lib.Api.H3ToGeo(H3Lib.H3Index,H3Lib.GeoCoord@)">
<summary>
find the lat/lon center point g of the cell h3
</summary>
</member>
<member name="M:H3Lib.Api.H3ToGeoBoundary(H3Lib.H3Index,H3Lib.GeoBoundary@)">
<summary>
give the cell boundary in lat/lon coordinates for the cell h3
</summary>
</member>
<member name="M:H3Lib.Api.MaxKringSize(System.Int32)">
<summary>
maximum number of hexagons in k-ring
</summary>
</member>
<member name="M:H3Lib.Api.HexRange(H3Lib.H3Index,System.Int32,System.Collections.Generic.List{H3Lib.H3Index}@)">
<summary>
hexagons neighbors in all directions, assuming no pentagons
</summary>
</member>
<member name="M:H3Lib.Api.HexRangeDistances(H3Lib.H3Index,System.Int32,System.Collections.Generic.List{H3Lib.H3Index}@,System.Collections.Generic.List{System.Int32}@)">
<summary>
hexagons neighbors in all directions, assuming no pentagons,
reporting distance from origin
</summary>
</member>
<member name="M:H3Lib.Api.HexRanges(System.Collections.Generic.List{H3Lib.H3Index},System.Int32,System.Int32,System.Collections.Generic.List{H3Lib.H3Index}@)">
<summary>
collection of hex rings sorted by ring for all given hexagons
</summary>
</member>
<member name="M:H3Lib.Api.KRing(H3Lib.H3Index,System.Int32,System.Collections.Generic.List{H3Lib.H3Index}@)">
<summary>
hexagon neighbors in all directions
</summary>
</member>
<member name="M:H3Lib.Api.KRingDistances(H3Lib.H3Index,System.Int32,System.Collections.Generic.List{H3Lib.H3Index}@,System.Collections.Generic.List{System.Int32}@)">
<summary>
hexagon neighbors in all directions, reporting distance from origin
</summary>
</member>
<member name="M:H3Lib.Api.HexRing(H3Lib.H3Index,System.Int32,System.Collections.Generic.List{H3Lib.H3Index}@)">
<summary>
hollow hexagon ring at some origin
</summary>
<param name="origin"></param>
<param name="k"></param>
<param name="outCells"></param>
<returns></returns>
</member>
<member name="M:H3Lib.Api.MaxPolyFillSize(H3Lib.GeoPolygon,System.Int32)">
<summary>
maximum number of hexagons in the geofence
</summary>
<param name="polygon"></param>
<param name="r"></param>
<returns></returns>
</member>
<member name="M:H3Lib.Api.PolyFill(H3Lib.GeoPolygon,System.Int32,System.Collections.Generic.List{H3Lib.H3Index}@)">
<summary>
hexagons within the given geofence
</summary>
<param name="polygon"></param>
<param name="r"></param>
<param name="outCells"></param>
</member>
<member name="M:H3Lib.Api.H3SetToLinkedGeo(System.Collections.Generic.List{H3Lib.H3Index},H3Lib.LinkedGeoPolygon@)">
<summary>
Create a LinkedGeoPolygon from a set of contiguous hexagons
</summary>
<param name="h3Set"></param>
<param name="outPolygon"></param>
</member>
<member name="M:H3Lib.Api.DegreesToRadians(System.Decimal)">
<summary>
converts degrees to radians
</summary>
<param name="degrees"></param>
<returns></returns>
</member>
<member name="M:H3Lib.Api.RadiansToDegrees(System.Decimal)">
<summary>
converts radians to degrees
</summary>
<returns></returns>
</member>
<member name="M:H3Lib.Api.PointDistRads(H3Lib.GeoCoord,H3Lib.GeoCoord)">
<summary>
"great circle distance" between pairs of GeoCoord points in radians*/
</summary>
<param name="a"></param>
<param name="b"></param>
<returns></returns>
</member>
<member name="M:H3Lib.Api.PointDistKm(H3Lib.GeoCoord,H3Lib.GeoCoord)">
<summary>
"great circle distance" between pairs of GeoCoord points in kilometers
</summary>
<param name="a"></param>
<param name="b"></param>
<returns></returns>
</member>
<member name="M:H3Lib.Api.PointDistM(H3Lib.GeoCoord,H3Lib.GeoCoord)">
<summary>
"great circle distance" between pairs of GeoCoord points in meters*/
</summary>
</member>
<member name="M:H3Lib.Api.HexAreaKm2(System.Int32)">
<summary>
average hexagon area in square kilometers (excludes pentagons)
</summary>
</member>
<member name="M:H3Lib.Api.HexAreaM2(System.Int32)">
<summary>
average hexagon area in square meters (excludes pentagons)
</summary>
</member>
<member name="M:H3Lib.Api.CellAreaRads2(H3Lib.H3Index)">
<summary>
exact area for a specific cell (hexagon or pentagon) in radians^2
</summary>
</member>
<member name="M:H3Lib.Api.CellAreaKm2(H3Lib.H3Index)">
<summary>
exact area for a specific cell (hexagon or pentagon) in kilometers^2
</summary>
</member>
<member name="M:H3Lib.Api.CellAreaM2(H3Lib.H3Index)">
<summary>
exact area for a specific cell (hexagon or pentagon) in meters^2
</summary>
</member>
<member name="M:H3Lib.Api.EdgeLengthKm(System.Int32)">
<summary>
average hexagon edge length in kilometers (excludes pentagons)
</summary>
</member>
<member name="M:H3Lib.Api.EdgeLengthM(System.Int32)">
<summary>
average hexagon edge length in meters (excludes pentagons)
</summary>
</member>
<member name="M:H3Lib.Api.ExactEdgeLengthRads(H3Lib.H3Index)">
<summary>
exact length for a specific unidirectional edge in radians*/
</summary>
</member>
<member name="M:H3Lib.Api.ExactEdgeLengthKm(H3Lib.H3Index)">
<summary>
exact length for a specific unidirectional edge in kilometers*/
</summary>
</member>
<member name="M:H3Lib.Api.ExactEdgeLengthM(H3Lib.H3Index)">
<summary>
exact length for a specific unidirectional edge in meters*/
</summary>
</member>
<member name="M:H3Lib.Api.NumHexagons(System.Int32)">
<summary>
number of cells (hexagons and pentagons) for a given resolution
</summary>
</member>
<member name="M:H3Lib.Api.Res0IndexCount">
<summary>
returns the number of resolution 0 cells (hexagons and pentagons)
</summary>
</member>
<member name="M:H3Lib.Api.GetRes0Indexes(System.Collections.Generic.List{H3Lib.H3Index}@)">
<summary>
provides all base cells in H3Index format*/
</summary>
</member>
<member name="M:H3Lib.Api.PentagonIndexCount">
<summary>
returns the number of pentagons per resolution
</summary>
</member>
<member name="M:H3Lib.Api.GetPentagonIndexes(System.Int32,System.Collections.Generic.List{H3Lib.H3Index}@)">
<summary>
generates all pentagons at the specified resolution
</summary>
</member>
<member name="M:H3Lib.Api.H3GetResolution(H3Lib.H3Index)">
<summary>
returns the resolution of the provided H3 index
Works on both cells and unidirectional edges.
</summary>
</member>
<member name="M:H3Lib.Api.H3GetBaseCell(H3Lib.H3Index)">
<summary>
returns the base cell "number" (0 to 121) of the provided H3 cell
</summary>
</member>
<member name="M:H3Lib.Api.StringToH3(System.String)">
<summary>
converts the canonical string format to H3Index format
</summary>
</member>
<member name="M:H3Lib.Api.H3ToString(H3Lib.H3Index,System.String@)">
<summary>
converts an H3Index to a canonical string
</summary>
</member>
<member name="M:H3Lib.Api.H3IsValid(H3Lib.H3Index)">
<summary>
confirms if an H3Index is a valid cell (hexagon or pentagon)
</summary>
</member>
<member name="M:H3Lib.Api.H3ToParent(H3Lib.H3Index,System.Int32)">
<summary>
returns the parent (or grandparent, etc) hexagon of the given hexagon
</summary>
</member>
<member name="M:H3Lib.Api.MaxH3ToChildrenSize(H3Lib.H3Index,System.Int32)">
<summary>
determines the maximum number of children (or grandchildren, etc)
</summary>
</member>
<member name="M:H3Lib.Api.H3ToChildren(H3Lib.H3Index,System.Int32,System.Collections.Generic.List{H3Lib.H3Index}@)">
<summary>
provides the children (or grandchildren, etc) of the given hexagon
</summary>
</member>
<member name="M:H3Lib.Api.H3ToCenterChild(H3Lib.H3Index,System.Int32)">
<summary>
returns the center child of the given hexagon at the specified
</summary>
</member>
<member name="M:H3Lib.Api.Compact(System.Collections.Generic.List{H3Lib.H3Index},System.Collections.Generic.List{H3Lib.H3Index}@)">
<summary>
compacts the given set of hexagons as best as possible
</summary>
</member>
<member name="M:H3Lib.Api.MaxUncompactSize(H3Lib.H3Index,System.Int32)">
<summary>
determines the maximum number of hexagons that could be uncompacted
from the compacted set
</summary>
</member>
<member name="M:H3Lib.Api.Uncompact(System.Collections.Generic.List{H3Lib.H3Index},System.Collections.Generic.List{H3Lib.H3Index}@,System.Int32)">
<summary>
uncompacts the compacted hexagon set
</summary>
</member>
<member name="M:H3Lib.Api.H3IsResClassIii(H3Lib.H3Index)">
<summary>
determines if a hexagon is Class III (or Class II)
</summary>
</member>
<member name="M:H3Lib.Api.H3IsPentagon(H3Lib.H3Index)">
<summary>
determines if an H3 cell is a pentagon
</summary>
</member>
<member name="M:H3Lib.Api.MaxFaceCount(H3Lib.H3Index)">
<summary>
Max number of icosahedron faces intersected by an index
</summary>
</member>
<member name="M:H3Lib.Api.H3GetFaces(H3Lib.H3Index,System.Collections.Generic.List{System.Int32}@)">
<summary>
Find all icosahedron faces intersected by a given H3 index
</summary>
</member>
<member name="M:H3Lib.Api.H3IndexesAreNeighbors(H3Lib.H3Index,H3Lib.H3Index)">
<summary>
returns whether or not the provided hexagons border
</summary>
</member>
<member name="M:H3Lib.Api.GetH3UnidirectionalEdge(H3Lib.H3Index,H3Lib.H3Index)">
<summary>
returns the unidirectional edge H3Index for the specified origin and
destination
</summary>
</member>
<member name="M:H3Lib.Api.H3UnidirectionalEdgeIsValid(H3Lib.H3Index)">
<summary>
returns whether the H3Index is a valid unidirectional edge
</summary>
</member>
<member name="M:H3Lib.Api.GetOriginH3IndexFromUnidirectionalEdge(H3Lib.H3Index)">
<summary>
Returns the origin hexagon H3Index from the unidirectional edge
</summary>
H3Index
</member>
<member name="M:H3Lib.Api.GetDestinationH3IndexFromUnidirectionalEdge(H3Lib.H3Index)">
<summary>
Returns the destination hexagon H3Index from the unidirectional edge
H3Index
</summary>
</member>
<member name="M:H3Lib.Api.GetH3IndexesFromUnidirectionalEdge(H3Lib.H3Index,System.ValueTuple{H3Lib.H3Index,H3Lib.H3Index}@)">
<summary>
Returns the origin and destination hexagons from the unidirectional
edge H3Index
</summary>
</member>
<member name="M:H3Lib.Api.GetH3UnidirectionalEdgesFromHexagon(H3Lib.H3Index,System.Collections.Generic.List{H3Lib.H3Index}@)">
<summary>
Returns the 6 (or 5 for pentagons) edges associated with the H3Index
</summary>
</member>
<member name="M:H3Lib.Api.GetH3UnidirectionalEdgeBoundary(H3Lib.H3Index,H3Lib.GeoBoundary@)">
<summary>
Returns the GeoBoundary containing the coordinates of the edge
</summary>
</member>
<member name="M:H3Lib.Api.H3Distance(H3Lib.H3Index,H3Lib.H3Index)">
<summary>
Returns grid distance between two indexes
</summary>
</member>
<member name="M:H3Lib.Api.H3LineSize(H3Lib.H3Index,H3Lib.H3Index)">
<summary>
Number of indexes in a line connecting two indexes
</summary>
</member>
<member name="M:H3Lib.Api.H3Line(H3Lib.H3Index,H3Lib.H3Index,System.Collections.Generic.List{H3Lib.H3Index}@)">
<summary>
Line of h3 indexes connecting two indexes
</summary>
</member>
<member name="M:H3Lib.Api.ExperimentalH3ToLocalIj(H3Lib.H3Index,H3Lib.H3Index,H3Lib.CoordIj@)">
<summary>
Returns two dimensional coordinates for the given index
</summary>
</member>
<member name="M:H3Lib.Api.ExperimentalLocalIjToH3(H3Lib.H3Index,H3Lib.CoordIj,H3Lib.H3Index@)">
<summary>
Returns index for the given two dimensional coordinates
</summary>
</member>
<member name="M:H3Lib.Api.SetGeoDegs(System.Decimal,System.Decimal)">
<summary>
Winging this one, returns a GeoCoord with degree values instead of radians
</summary>
</member>
<member name="M:H3Lib.Api.DestroyLinkedPolygon(H3Lib.LinkedGeoPolygon)">
<summary>
Erases all the information for a linkedgeopolygon
</summary>
<param name="polygon"></param>
</member>
<member name="M:H3Lib.Api.DegsToRads(System.Decimal)">
<summary>
Converts degrees to radians.
</summary>
</member>
<member name="M:H3Lib.Api.RadsToDegs(System.Decimal)">
<summary>
Converts radians to degrees
</summary>
</member>
<member name="T:H3Lib.BaseCellData">
<summary>
Information on a single base cell
</summary>
<!--
baseCells.h
typedef struct BaseCellData
-->
</member>
<member name="F:H3Lib.BaseCellData.HomeFijk">
<summary>
"Home" face and normalized ijk coordinates on that face
</summary>
</member>
<member name="F:H3Lib.BaseCellData.IsPentagon">
<summary>
Is this base cell a pentagon?
</summary>
</member>
<member name="F:H3Lib.BaseCellData.ClockwiseOffsetPentagon">
<summary>
If it's a pentagon, what are its two clockwise offset faces?
</summary>
</member>
<member name="M:H3Lib.BaseCellData.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>
Extended constructor
</summary>
<param name="face">Face of BaseCellData</param>
<param name="faceI">I coordinate</param>
<param name="faceJ">J Coordinate</param>
<param name="faceK">K Coordinate</param>
<param name="isPentagon">Is cell pentagon?</param>
<param name="offset1">offset 1</param>
<param name="offset2">offset 2</param>
</member>
<member name="M:H3Lib.BaseCellData.Equals(H3Lib.BaseCellData)">
<summary>
Test for equality
</summary>
<param name="other">BaseCellData to test against</param>
</member>
<member name="M:H3Lib.BaseCellData.Equals(System.Object)">
<summary>
Test for equality against object that can be unboxed
</summary>
<param name="obj">Object to unbox if BaseCellData</param>
</member>
<member name="M:H3Lib.BaseCellData.GetHashCode">
<summary>
HashCode for identity
</summary>
</member>
<member name="M:H3Lib.BaseCellData.op_Equality(H3Lib.BaseCellData,H3Lib.BaseCellData)">
<summary>
Test for equality
</summary>
<param name="left">lhs item</param>
<param name="right">rhs item</param>
<returns></returns>
</member>
<member name="M:H3Lib.BaseCellData.op_Inequality(H3Lib.BaseCellData,H3Lib.BaseCellData)">
<summary>
Test for inequality
</summary>
<param name="left">lhs item</param>
<param name="right">rhd item</param>
<returns></returns>
</member>
<member name="T:H3Lib.BaseCellRotation">
<summary>
base cell at a given ijk and required rotations into its system
</summary>
<!--
baseCells.c
typedef struct BaseCellRotation
-->
</member>
<member name="F:H3Lib.BaseCellRotation.BaseCell">
<summary>
base cell number
</summary>
</member>
<member name="F:H3Lib.BaseCellRotation.CounterClockwiseRotate60">
<summary>
number of ccw 60 degree rotations relative to current face
</summary>
</member>
<member name="M:H3Lib.BaseCellRotation.#ctor(System.Int32,System.Int32)">
<summary>
constructor
</summary>
</member>
<member name="M:H3Lib.BaseCellRotation.Equals(H3Lib.BaseCellRotation)">
<summary>
Test for equality against BaseCellRotation
</summary>
</member>
<member name="M:H3Lib.BaseCellRotation.Equals(System.Object)">
<summary>
Test for equality against object that can be unboxed to BaseCellRotation
</summary>
</member>
<member name="M:H3Lib.BaseCellRotation.GetHashCode">
<summary>
Hashcode for identity
</summary>
</member>
<member name="M:H3Lib.BaseCellRotation.op_Equality(H3Lib.BaseCellRotation,H3Lib.BaseCellRotation)">
<summary>
Test for equality
</summary>
</member>
<member name="M:H3Lib.BaseCellRotation.op_Inequality(H3Lib.BaseCellRotation,H3Lib.BaseCellRotation)">
<summary>
Test for inequality
</summary>
</member>
<member name="T:H3Lib.BBox">
<summary>
Geographic bounding box with coordinates defined in radians
</summary>
</member>
<member name="F:H3Lib.BBox.North">
<summary>
North limit
</summary>
</member>
<member name="F:H3Lib.BBox.South">
<summary>
South limit
</summary>
</member>
<member name="F:H3Lib.BBox.East">
<summary>
East limit
</summary>
</member>
<member name="F:H3Lib.BBox.West">
<summary>
West limit
</summary>
</member>
<member name="P:H3Lib.BBox.IsTransmeridian">
<summary>
Whether the given bounding box crosses the antimeridian
</summary>
<!--
bbox.c
bboxIsTransmeridian
-->
</member>
<member name="M:H3Lib.BBox.#ctor(System.Decimal,System.Decimal,System.Decimal,System.Decimal)">
<summary>
constructor
</summary>
</member>
<member name="M:H3Lib.BBox.Equals(H3Lib.BBox)">
<summary>
Test for equality within measure of error against other BBox
</summary>
</member>
<member name="M:H3Lib.BBox.Equals(System.Object)">
<summary>
Test for object that can be unboxed to BBox
</summary>
</member>
<member name="M:H3Lib.BBox.GetHashCode">
<summary>
Hashcode for identity
</summary>
<returns></returns>
</member>
<member name="M:H3Lib.BBox.op_Equality(H3Lib.BBox,H3Lib.BBox)">
<summary>
Test for equality
</summary>
</member>
<member name="M:H3Lib.BBox.op_Inequality(H3Lib.BBox,H3Lib.BBox)">
<summary>
Test for inequality
</summary>
</member>
<member name="T:H3Lib.Constants">
<summary>
Collection of constants used throughout the library.
</summary>
</member>
<member name="F:H3Lib.Constants.H3_VERSION_MAJOR">
<summary>
Major version
</summary>
</member>
<member name="F:H3Lib.Constants.H3_VERSION_MINOR">
<summary>
Minor version
</summary>
</member>
<member name="F:H3Lib.Constants.H3_VERSION_PATCH">
<summary>
Patch version
</summary>
</member>
<member name="T:H3Lib.Constants.H3">
<summary>
Internal values for all of H3
</summary>
</member>
<member name="F:H3Lib.Constants.H3.M_PI">
<summary>
Pi
</summary>
</member>
<member name="F:H3Lib.Constants.H3.M_PI_2">
<summary>
Pi / 2.0
</summary>
</member>
<member name="F:H3Lib.Constants.H3.M_2PI">
<summary>
Pi * 2.0
</summary>
</member>
<member name="F:H3Lib.Constants.H3.M_PI_180">
<summary>
Pi / 180
</summary>
</member>
<member name="F:H3Lib.Constants.H3.M_180_PI">
<summary>
180 / Pi
</summary>
</member>
<member name="F:H3Lib.Constants.H3.EPSILON">
<summary>
Threshold epsilon
</summary>
</member>
<member name="F:H3Lib.Constants.H3.M_SQRT3_2">
<summary>
Sqrt(3) / 2.0
</summary>
</member>
<member name="F:H3Lib.Constants.H3.M_SIN60">
<summary>
sin(60 degrees)
</summary>
</member>
<member name="F:H3Lib.Constants.H3.M_AP7_ROT_RADS">
<summary>
Rotation angle between Class II and Class III resolution axes
asin(sqrt(3.0 / 28.0 ))
</summary>
</member>
<member name="F:H3Lib.Constants.H3.M_SIN_AP7_ROT">
<summary>
sin(<see cref="F:H3Lib.Constants.H3.M_AP7_ROT_RADS"/>
</summary>
</member>
<member name="F:H3Lib.Constants.H3.M_COS_AP7_ROT">
<summary>
cos(<see cref="F:H3Lib.Constants.H3.M_AP7_ROT_RADS"/>
</summary>
</member>
<member name="F:H3Lib.Constants.H3.EARTH_RADIUS_KM">
<summary>
Earth radius in kilometers using WGS84 authalic radius
</summary>
</member>
<member name="F:H3Lib.Constants.H3.RES0_U_GNOMONIC">
<summary>
Scaling factor from hex2d resolution 0 unit length
(or distance between adjacent cell center points on the place)
to gnomonic unit length.
</summary>
</member>
<member name="F:H3Lib.Constants.H3.MAX_H3_RES">
<summary>
H3 resolution; H3 version 1 has 16 resolutions, numbered 0 through 15
</summary>
</member>
<member name="F:H3Lib.Constants.H3.NUM_ICOSA_FACES">
<summary>
The number of faces on an icosahedron
</summary>
</member>
<member name="F:H3Lib.Constants.H3.NUM_BASE_CELLS">
<summary>
The number of H3 base cells
</summary>
</member>
<member name="F:H3Lib.Constants.H3.NUM_HEX_VERTS">
<summary>
The number of vertices in a hexagon;
</summary>
</member>
<member name="F:H3Lib.Constants.H3.NUM_PENT_VERTS">
<summary>
The number of vertices in a pentagon
</summary>
</member>
<member name="F:H3Lib.Constants.H3.H3_HEXAGON_MODE">
<summary>
H3 Index modes
</summary>
</member>
<member name="F:H3Lib.Constants.H3.EPSILON_DEG">
<summary>
epsilon of ~0.1mm in degrees
</summary>
</member>
<member name="F:H3Lib.Constants.H3.EPSILON_RAD">
<summary>
epsilon of ~0.1mm in radians
</summary>
</member>
<member name="F:H3Lib.Constants.H3.DBL_EPSILON">
<summary>
General margin of error in differences between double values
Original value was 2.2204460492503131e-16;
This is relevant to accuracy's interest, methinks
https://github.com/dotnet/runtime/issues/8528
</summary>
</member>
<member name="F:H3Lib.Constants.H3.NEXT_RING_DIRECTION">
<summary>
Direction used for traversing to the next outward hexagonal ring.
</summary>
</member>
<member name="F:H3Lib.Constants.Algos.Directions">
<summary>
<code>
_
_/ \_ Directions used for traversing a
/ \5/ \ hexagonal ring counterclockwise
\0/ \4/ around {1, 0, 0}
/ \_/ \
\1/ \3/
\2/
</code>
</summary>
<!--
algos.c
-->
</member>
<member name="F:H3Lib.Constants.Algos.NextRingDirection">
<summary>
Direction used for traversing to the next outward hexagonal ring.
</summary>
<!--
Algos.c
NEXT_RING_DIRECTION
-->
</member>
<member name="F:H3Lib.Constants.Algos.NewDigitIi">
<summary>
New digit when traversing along class II grids.
Current digit -> direction -> new digit.
</summary>
<!--
Algos.c
NEW_DIGIT_II
-->
</member>
<member name="F:H3Lib.Constants.Algos.NewAdjustmentIi">
<summary>
New traversal direction when traversing along class II grids.
Current digit -> direction -> new ap7 move (at coarser level).
</summary>
<!--
Algos.c
NEW_ADJUSTMENT_II
-->
</member>
<member name="F:H3Lib.Constants.Algos.NewDigitIii">
<summary>
New traversal direction when traversing along class III grids.
Current digit -> direction -> new ap7 move (at coarser level).
</summary>
<!--
Algos.c
NEW_DIGIT_III
-->
</member>
<member name="F:H3Lib.Constants.Algos.NewAdjustmentIii">
<summary>
New traversal direction when traversing along class III grids.
Current digit -gt; direction -gt; new ap7 move (at coarser level).
</summary>
<!--
algos.c
NEW_ADJUSTMENT_III
-->
</member>
<member name="F:H3Lib.Constants.BaseCells.MaxFaceCoord">
<summary>
Maximum input for any component to face-to-base-cell lookup functions
</summary>
</member>
<member name="F:H3Lib.Constants.BaseCells.InvalidRotations">
<summary>
Invalid number of rotations
</summary>
</member>
<member name="F:H3Lib.Constants.BaseCells.BaseCellNeighbors">
<summary>
Neighboring base cell ID in each IJK direction.
For each base cell, for each direction, the neighboring base
cell ID is given. 127 indicates there is no neighbor in that direction.
</summary>
</member>
<member name="F:H3Lib.Constants.BaseCells.BaseCellNeighbor60CounterClockwiseRotation">
<summary>
Neighboring base cell rotations in each IJK direction.
For each base cell, for each direction, the number of 60 degree
CCW rotations to the coordinate system of the neighbor is given.
-1 indicates there is no neighbor in that direction.
</summary>
<!--
baseCells.c
baseCellNeighbor60CCWRots
-->
</member>
<member name="F:H3Lib.Constants.BaseCells.FaceIjkBaseCells">
<summary>
Resolution 0 base cell lookup table for each face.
Given the face number and a resolution 0 ijk+ coordinate in that face's
face-centered ijk coordinate system, gives the base cell located at that
coordinate and the number of 60 ccw rotations to rotate into that base
cell's orientation.
Valid lookup coordinates are from (0, 0, 0) to (2, 2, 2).
This table can be accessed using the functions BaseCells._faceIjkToBaseCell
and BaseCells.ToBaseCellCounterClockwiseRotate60
</summary>
</member>
<member name="F:H3Lib.Constants.BaseCells.BaseCellData">
<summary>
Resolution 0 base cell data table.
For each base cell, gives the "home" face and ijk+ coordinates on that face,
whether or not the base cell is a pentagon. Additionally, if the base cell
is a pentagon, the two cw offset rotation adjacent faces are given (-1
indicates that no cw offset rotation faces exist for this base cell).
</summary>
</member>
<member name="F:H3Lib.Constants.CoordIjk.UnitVecs">
<summary>
CoordIJK unit vectors corresponding to the 7 H3 digits.
</summary>
</member>
<member name="F:H3Lib.Constants.FaceIjk.InvalidFace">
<summary>
Invalid face index
</summary>
</member>
<member name="F:H3Lib.Constants.FaceIjk.IJ">
<summary>
IJ quadrant faceNeighbors table direction
</summary>
</member>
<member name="F:H3Lib.Constants.FaceIjk.KI">
<summary>
KI quadrant faceNeighbors table direction
</summary>
</member>
<member name="F:H3Lib.Constants.FaceIjk.JK">
<summary>
JK quadrant faceNeighbors table direction
</summary>
</member>
<member name="F:H3Lib.Constants.FaceIjk.MSqrt7">
<summary>
Square root of 7
</summary>
</member>
<member name="F:H3Lib.Constants.FaceIjk.FaceCenterGeo">
<summary>
icosahedron face centers in lat/lon radians
</summary>
</member>
<member name="F:H3Lib.Constants.FaceIjk.FaceCenterPoint">
<summary>
icosahedron face centers in x/y/z on the unit sphere
</summary>
</member>
<member name="F:H3Lib.Constants.FaceIjk.FaceAxesAzRadsCii">
<summary>
icosahedron face ijk axes as azimuth in radians from face center to
vertex 0/1/2 respectively
</summary>
</member>
<member name="F:H3Lib.Constants.FaceIjk.FaceNeighbors">
<summary>
Definition of which faces neighbor each other.
</summary>
</member>
<member name="F:H3Lib.Constants.FaceIjk.AdjacentFaceDir">
<summary>
direction from the origin face to the destination face, relative to
the origin face's coordinate system, or -1 if not adjacent.
</summary>
</member>
<member name="F:H3Lib.Constants.FaceIjk.MaxDimByCiiRes">
<summary>
overage distance table
</summary>
</member>
<member name="F:H3Lib.Constants.FaceIjk.UnitScaleByCiiRes">
<summary>
unit scale distance table
</summary>
</member>
<member name="F:H3Lib.Constants.H3Index.H3_INVALID_INDEX">
<summary>
Invalid index used to indicate an error from geoToH3 and related functions.
</summary>
</member>
<member name="F:H3Lib.Constants.H3Index.H3_NULL">
<summary>
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.
</summary>
</member>
<member name="F:H3Lib.Constants.H3Index.H3_NUM_BITS">
<summary>
The number of bits in an H3 index.
</summary>
</member>
<member name="F:H3Lib.Constants.H3Index.H3_MAX_OFFSET">
<summary>
The bit offset of the max resolution digit in an H3 index.
</summary>
</member>
<member name="F:H3Lib.Constants.H3Index.H3_MODE_OFFSET">
<summary>
The bit offset of the mode in an H3 index.
</summary>
</member>
<member name="F:H3Lib.Constants.H3Index.H3_BC_OFFSET">
<summary>
The bit offset of the base cell in an H3 index.
</summary>
</member>
<member name="F:H3Lib.Constants.H3Index.H3_RES_OFFSET">
<summary>
The bit offset of the resolution in an H3 index.
</summary>
</member>
<member name="F:H3Lib.Constants.H3Index.H3_RESERVED_OFFSET">
<summary>
The bit offset of the reserved bits in an H3 index.
</summary>
</member>
<member name="F:H3Lib.Constants.H3Index.H3_PER_DIGIT_OFFSET">
<summary>
The number of bits in a single H3 resolution digit.
</summary>
</member>
<member name="F:H3Lib.Constants.H3Index.H3_HIGH_BIT_MASK">
<summary>
1 in the highest bit, 0's everywhere else.
</summary>
</member>
<member name="F:H3Lib.Constants.H3Index.H3_HIGH_BIT_MASK_NEGATIVE">
<summary>
0 in the highest bit, 1's everywhere else.
</summary>
</member>
<member name="F:H3Lib.Constants.H3Index.H3_MODE_MASK">
<summary>
1's in the 4 mode bits, 0's everywhere else.
</summary>
</member>
<member name="F:H3Lib.Constants.H3Index.H3_MODE_MASK_NEGATIVE">
<summary>
0's in the 4 mode bits, 1's everywhere else.
</summary>
</member>
<member name="F:H3Lib.Constants.H3Index.H3_BC_MASK">
<summary>
1's in the 7 base cell bits, 0's everywhere else.
</summary>
</member>
<member name="F:H3Lib.Constants.H3Index.H3_BC_MASK_NEGATIVE">
<summary>
0's in the 7 base cell bits, 1's everywhere else.
</summary>
</member>
<member name="F:H3Lib.Constants.H3Index.H3_INIT">
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.
</member>
<member name="F:H3Lib.Constants.H3Index.H3_RES_MASK">
<summary>
1's in the 4 resolution bits, 0's everywhere else.
</summary>
</member>
<member name="F:H3Lib.Constants.H3Index.H3_RES_MASK_NEGATIVE">
<summary>
0's in the 4 resolution bits, 1's everywhere else.
</summary>
</member>
<member name="F:H3Lib.Constants.H3Index.H3_RESERVED_MASK">
<summary>
1's in the 3 reserved bits, 0's everywhere else.
</summary>
</member>
<member name="F:H3Lib.Constants.H3Index.H3_RESERVED_MASK_NEGATIVE">
<summary>
0's in the 3 reserved bits, 1's everywhere else.
</summary>
</member>
<member name="F:H3Lib.Constants.H3Index.H3_DIGIT_MASK">
<summary>
1's in the 3 bits of res 15 digit bits, 0's everywhere else.
</summary>
</member>
<member name="F:H3Lib.Constants.H3Index.H3_DIGIT_MASK_NEGATIVE">