Skip to content

Commit 942baab

Browse files
clarify point.distance function (#1064)
1 parent c0be0b4 commit 942baab

File tree

3 files changed

+9
-3
lines changed

3 files changed

+9
-3
lines changed

modules/ROOT/pages/appendix/gql-conformance/additional-cypher.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,9 @@ Either the pattern already exists, or it needs to be created.
301301
| Returns a 2D or 3D point object, given two or respectively three coordinate values in the Cartesian coordinate system or WGS 84 geographic coordinate system.
302302

303303
| xref:functions/spatial.adoc#functions-point-distance[`point.distance()`]
304-
| Returns a `FLOAT` representing the geodesic distance between any two points in the same CRS.
304+
| Returns a `FLOAT` representing the distance between any two points in the same CRS.
305+
If the points are in the WGS 84 CRS, the function returns the geodesic distance (i.e., the shortest path along the curved surface of the Earth).
306+
If the points are in a Cartesian CRS, the function returns the Euclidean distance (i.e., the shortest straight-line distance in a flat, planar space).
305307

306308
| xref:functions/spatial.adoc#functions-point-withinBBox[`point.withinBBox()`]
307309
| Returns true if the provided point is within the bounding box defined by the two provided points.

modules/ROOT/pages/functions/index.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -573,7 +573,9 @@ These functions are used to specify 2D or 3D points in a geographic or cartesian
573573

574574
1.1+| xref::functions/spatial.adoc#functions-distance[`point.distance()`]
575575
| `point.distance(from :: POINT, to :: POINT) :: FLOAT`
576-
| Returns a `FLOAT` representing the geodesic distance between any two points in the same CRS.
576+
| Returns a `FLOAT` representing the distance between any two points in the same CRS.
577+
If the points are in the WGS 84 CRS, the function returns the geodesic distance (i.e., the shortest path along the curved surface of the Earth).
578+
If the points are in a Cartesian CRS, the function returns the Euclidean distance (i.e., the shortest straight-line distance in a flat, planar space).
577579

578580
1.1+| xref::functions/spatial.adoc#functions-withinBBox[`point.withinBBox()`]
579581
| `point.withinBBox(point :: POINT, lowerLeft :: POINT, upperRight :: POINT) :: BOOLEAN`

modules/ROOT/pages/functions/spatial.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,9 @@ If `null` is provided as the argument, `null` is returned.
250250
.Details
251251
|===
252252
| *Syntax* 3+| `point.distance(from, to)`
253-
| *Description* 3+| Returns a `FLOAT` representing the geodesic distance between any two points in the same CRS.
253+
| *Description* 3+| Returns a `FLOAT` representing the distance between any two points in the same CRS.
254+
If the points are in the WGS 84 CRS, the function returns the geodesic distance (i.e., the shortest path along the curved surface of the Earth).
255+
If the points are in a Cartesian CRS, the function returns the Euclidean distance (i.e., the shortest straight-line distance in a flat, planar space).
254256
.3+| *Arguments* | *Name* | *Type* | *Description*
255257
| `from` | `POINT` | A start point.
256258
| `to` | `POINT` | An end point in the same CRS as the start point.

0 commit comments

Comments
 (0)