Skip to content

Commit e10530f

Browse files
authored
exactEdgeLengthKm -> edgeLengthKm (#639)
1 parent f6669a7 commit e10530f

File tree

8 files changed

+46
-48
lines changed

8 files changed

+46
-48
lines changed

CMakeLists.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ set(OTHER_SOURCE_FILES
232232
src/apps/fuzzers/fuzzerCellsToLinkedMultiPolygon.c
233233
src/apps/fuzzers/fuzzerDistances.c
234234
src/apps/fuzzers/fuzzerCellArea.c
235-
src/apps/fuzzers/fuzzerExactEdgeLength.c
235+
src/apps/fuzzers/fuzzerEdgeLength.c
236236
src/apps/fuzzers/fuzzerCellProperties.c
237237
src/apps/fuzzers/fuzzerIndexIO.c
238238
src/apps/fuzzers/fuzzerResolutions.c
@@ -476,7 +476,7 @@ if(BUILD_FUZZERS)
476476
add_h3_fuzzer(fuzzerCellsToLinkedMultiPolygon src/apps/fuzzers/fuzzerCellsToLinkedMultiPolygon.c)
477477
add_h3_fuzzer(fuzzerDistances src/apps/fuzzers/fuzzerDistances.c)
478478
add_h3_fuzzer(fuzzerCellArea src/apps/fuzzers/fuzzerCellArea.c)
479-
add_h3_fuzzer(fuzzerExactEdgeLength src/apps/fuzzers/fuzzerExactEdgeLength.c)
479+
add_h3_fuzzer(fuzzerEdgeLength src/apps/fuzzers/fuzzerEdgeLength.c)
480480
add_h3_fuzzer(fuzzerCellProperties src/apps/fuzzers/fuzzerCellProperties.c)
481481
add_h3_fuzzer(fuzzerIndexIO src/apps/fuzzers/fuzzerIndexIO.c)
482482
add_h3_fuzzer(fuzzerResolutions src/apps/fuzzers/fuzzerResolutions.c)

src/apps/fuzzers/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ such as the H3 core library.
2525
| getHexagonAreaAvg | [fuzzerResolutions](./fuzzerResolutions.c)
2626
| cellArea | [fuzzerCellArea](./fuzzerCellArea.c)
2727
| getHexagonEdgeLengthAvg | [fuzzerResolutions](./fuzzerResolutions.c)
28-
| exactEdgeLength | [fuzzerExactEdgeLength](./fuzzerExactEdgeLength.c)
28+
| edgeLength | [fuzzerEdgeLength](./fuzzerEdgeLength.c)
2929
| getNumCells | [fuzzerResolutions](./fuzzerResolutions.c)
3030
| getRes0Cells | Trivial
3131
| getPentagons | [fuzzerResolutions](./fuzzerResolutions.c)

src/apps/fuzzers/fuzzerExactEdgeLength.c renamed to src/apps/fuzzers/fuzzerEdgeLength.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616
/** @file
17-
* @brief Fuzzer program for exactEdgeLengthRads
17+
* @brief Fuzzer program for edgeLengthRads
1818
*/
1919

2020
#include "aflHarness.h"
@@ -32,9 +32,9 @@ int LLVMFuzzerTestOneInput(const uint8_t *data, size_t size) {
3232
const inputArgs *args = (const inputArgs *)data;
3333

3434
double distance;
35-
H3_EXPORT(exactEdgeLengthRads)(args->index, &distance);
36-
H3_EXPORT(exactEdgeLengthKm)(args->index, &distance);
37-
H3_EXPORT(exactEdgeLengthM)(args->index, &distance);
35+
H3_EXPORT(edgeLengthRads)(args->index, &distance);
36+
H3_EXPORT(edgeLengthKm)(args->index, &distance);
37+
H3_EXPORT(edgeLengthM)(args->index, &distance);
3838

3939
return 0;
4040
}

src/apps/testapps/testDirectedEdge.c

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -429,17 +429,15 @@ SUITE(directedEdge) {
429429
"directedEdgeToBoundary fails on invalid edge indexing digit");
430430
}
431431

432-
TEST(exactEdgeLength_invalid) {
432+
TEST(edgeLength_invalid) {
433433
double length;
434434
// Test that invalid inputs do not cause crashes.
435-
t_assert(
436-
H3_EXPORT(exactEdgeLengthRads)(0, &length) == E_DIR_EDGE_INVALID,
437-
"Invalid edge has zero length");
435+
t_assert(H3_EXPORT(edgeLengthRads)(0, &length) == E_DIR_EDGE_INVALID,
436+
"Invalid edge has zero length");
438437
LatLng zero = {0, 0};
439438
H3Index h3;
440439
t_assertSuccess(H3_EXPORT(latLngToCell)(&zero, 0, &h3));
441-
t_assert(
442-
H3_EXPORT(exactEdgeLengthRads)(h3, &length) == E_DIR_EDGE_INVALID,
443-
"Non-edge (cell) has zero edge length");
440+
t_assert(H3_EXPORT(edgeLengthRads)(h3, &length) == E_DIR_EDGE_INVALID,
441+
"Non-edge (cell) has zero edge length");
444442
}
445443
}

src/apps/testapps/testH3CellAreaExhaustive.c

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,21 +81,21 @@ static void haversine_assert(H3Index edge) {
8181
/**
8282
* Tests positivity of edge length calculation for the functions:
8383
*
84-
* exactEdgeLengthRads
85-
* exactEdgeLengthKm
86-
* exactEdgeLengthM
84+
* edgeLengthRads
85+
* edgeLengthKm
86+
* edgeLengthM
8787
*
8888
* @param edge edge to compute the length of
8989
*/
9090
static void edge_length_assert(H3Index edge) {
9191
char msg[] = "edge has positive length";
9292

9393
double length;
94-
t_assertSuccess(H3_EXPORT(exactEdgeLengthRads)(edge, &length));
94+
t_assertSuccess(H3_EXPORT(edgeLengthRads)(edge, &length));
9595
t_assert(length > 0, msg);
96-
t_assertSuccess(H3_EXPORT(exactEdgeLengthKm)(edge, &length));
96+
t_assertSuccess(H3_EXPORT(edgeLengthKm)(edge, &length));
9797
t_assert(length > 0, msg);
98-
t_assertSuccess(H3_EXPORT(exactEdgeLengthM)(edge, &length));
98+
t_assertSuccess(H3_EXPORT(edgeLengthM)(edge, &length));
9999
t_assert(length > 0, msg);
100100
}
101101

src/h3lib/include/h3api.h.in

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -369,18 +369,18 @@ DECLSPEC H3Error H3_EXPORT(getHexagonEdgeLengthAvgKm)(int res, double *out);
369369
DECLSPEC H3Error H3_EXPORT(getHexagonEdgeLengthAvgM)(int res, double *out);
370370
/** @} */
371371

372-
/** @defgroup exactEdgeLength exactEdgeLength
373-
* Functions for exactEdgeLength
372+
/** @defgroup edgeLength edgeLength
373+
* Functions for edgeLength
374374
* @{
375375
*/
376376
/** @brief exact length for a specific directed edge in radians*/
377-
DECLSPEC H3Error H3_EXPORT(exactEdgeLengthRads)(H3Index edge, double *length);
377+
DECLSPEC H3Error H3_EXPORT(edgeLengthRads)(H3Index edge, double *length);
378378

379379
/** @brief exact length for a specific directed edge in kilometers*/
380-
DECLSPEC H3Error H3_EXPORT(exactEdgeLengthKm)(H3Index edge, double *length);
380+
DECLSPEC H3Error H3_EXPORT(edgeLengthKm)(H3Index edge, double *length);
381381

382382
/** @brief exact length for a specific directed edge in meters*/
383-
DECLSPEC H3Error H3_EXPORT(exactEdgeLengthM)(H3Index edge, double *length);
383+
DECLSPEC H3Error H3_EXPORT(edgeLengthM)(H3Index edge, double *length);
384384
/** @} */
385385

386386
/** @defgroup getNumCells getNumCells

src/h3lib/lib/latLng.c

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -427,7 +427,7 @@ H3Error H3_EXPORT(cellAreaM2)(H3Index cell, double *out) {
427427
*
428428
* @return length in radians
429429
*/
430-
H3Error H3_EXPORT(exactEdgeLengthRads)(H3Index edge, double *length) {
430+
H3Error H3_EXPORT(edgeLengthRads)(H3Index edge, double *length) {
431431
CellBoundary cb;
432432

433433
H3Error err = H3_EXPORT(directedEdgeToBoundary)(edge, &cb);
@@ -447,17 +447,17 @@ H3Error H3_EXPORT(exactEdgeLengthRads)(H3Index edge, double *length) {
447447
/**
448448
* Length of a directed edge in kilometers.
449449
*/
450-
H3Error H3_EXPORT(exactEdgeLengthKm)(H3Index edge, double *length) {
451-
H3Error err = H3_EXPORT(exactEdgeLengthRads)(edge, length);
450+
H3Error H3_EXPORT(edgeLengthKm)(H3Index edge, double *length) {
451+
H3Error err = H3_EXPORT(edgeLengthRads)(edge, length);
452452
*length = *length * EARTH_RADIUS_KM;
453453
return err;
454454
}
455455

456456
/**
457457
* Length of a directed edge in meters.
458458
*/
459-
H3Error H3_EXPORT(exactEdgeLengthM)(H3Index edge, double *length) {
460-
H3Error err = H3_EXPORT(exactEdgeLengthKm)(edge, length);
459+
H3Error H3_EXPORT(edgeLengthM)(H3Index edge, double *length) {
460+
H3Error err = H3_EXPORT(edgeLengthKm)(edge, length);
461461
*length = *length * 1000;
462462
return err;
463463
}

website/docs/api/misc.mdx

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ function example() {
483483
Average hexagon edge length in meters at the given resolution. Excludes pentagons.
484484

485485

486-
## exactEdgeLengthKm
486+
## edgeLengthKm
487487

488488
<Tabs
489489
groupId="language"
@@ -498,7 +498,7 @@ Average hexagon edge length in meters at the given resolution. Excludes pentagon
498498
<TabItem value="c">
499499

500500
```c
501-
H3Error exactEdgeLengthKm(H3Index edge, double *length);
501+
H3Error edgeLengthKm(H3Index edge, double *length);
502502
```
503503
504504
</TabItem>
@@ -512,21 +512,21 @@ h3.exact_edge_length(h, unit='km')
512512
<TabItem value="java">
513513

514514
```java
515-
double exactEdgeLength(long h3, LengthUnit unit);
516-
double exactEdgeLength(String h3Address, LengthUnit unit);
515+
double edgeLength(long h3, LengthUnit unit);
516+
double edgeLength(String h3Address, LengthUnit unit);
517517
```
518518

519519
</TabItem>
520520
<TabItem value="javascript">
521521

522522
```js
523-
h3.exactEdgeLength(h3, h3.UNITS.km)
523+
h3.edgeLength(h3, h3.UNITS.km)
524524
```
525525

526526
```js live
527527
function example() {
528528
const h = '115283473fffffff';
529-
return h3.exactEdgeLength(h, h3.UNITS.km);
529+
return h3.edgeLength(h, h3.UNITS.km);
530530
}
531531
```
532532

@@ -535,7 +535,7 @@ function example() {
535535

536536
Exact edge length of specific unidirectional edge in kilometers.
537537

538-
## exactEdgeLengthM
538+
## edgeLengthM
539539

540540
<Tabs
541541
groupId="language"
@@ -550,7 +550,7 @@ Exact edge length of specific unidirectional edge in kilometers.
550550
<TabItem value="c">
551551

552552
```c
553-
H3Error exactEdgeLengthM(H3Index edge, double *length);
553+
H3Error edgeLengthM(H3Index edge, double *length);
554554
```
555555
556556
</TabItem>
@@ -564,21 +564,21 @@ h3.exact_edge_length(h, unit='m')
564564
<TabItem value="java">
565565

566566
```java
567-
double exactEdgeLength(long h3, LengthUnit unit);
568-
double exactEdgeLength(String h3Address, LengthUnit unit);
567+
double edgeLength(long h3, LengthUnit unit);
568+
double edgeLength(String h3Address, LengthUnit unit);
569569
```
570570

571571
</TabItem>
572572
<TabItem value="javascript">
573573

574574
```js
575-
h3.exactEdgeLength(h3, h3.UNITS.m)
575+
h3.edgeLength(h3, h3.UNITS.m)
576576
```
577577

578578
```js live
579579
function example() {
580580
const h = '115283473fffffff';
581-
return h3.exactEdgeLength(h, h3.UNITS.m);
581+
return h3.edgeLength(h, h3.UNITS.m);
582582
}
583583
```
584584

@@ -587,7 +587,7 @@ function example() {
587587

588588
Exact edge length of specific unidirectional edge in meters.
589589

590-
## exactEdgeLengthRads
590+
## edgeLengthRads
591591

592592
<Tabs
593593
groupId="language"
@@ -602,7 +602,7 @@ Exact edge length of specific unidirectional edge in meters.
602602
<TabItem value="c">
603603

604604
```c
605-
H3Error exactEdgeLengthRads(H3Index edge, double *length);
605+
H3Error edgeLengthRads(H3Index edge, double *length);
606606
```
607607
608608
</TabItem>
@@ -616,21 +616,21 @@ h3.exact_edge_length(h, unit='rads')
616616
<TabItem value="java">
617617

618618
```java
619-
double exactEdgeLength(long h3, LengthUnit unit);
620-
double exactEdgeLength(String h3Address, LengthUnit unit);
619+
double edgeLength(long h3, LengthUnit unit);
620+
double edgeLength(String h3Address, LengthUnit unit);
621621
```
622622

623623
</TabItem>
624624
<TabItem value="javascript">
625625

626626
```js
627-
h3.exactEdgeLength(h3, h3.UNITS.rads)
627+
h3.edgeLength(h3, h3.UNITS.rads)
628628
```
629629

630630
```js live
631631
function example() {
632632
const h = '115283473fffffff';
633-
return h3.exactEdgeLength(h, h3.UNITS.rads);
633+
return h3.edgeLength(h, h3.UNITS.rads);
634634
}
635635
```
636636

0 commit comments

Comments
 (0)