aboutsummaryrefslogtreecommitdiff
path: root/docs/source/development/reference/functions.rst
diff options
context:
space:
mode:
authorKristian Evers <kristianevers@gmail.com>2018-05-23 13:14:48 +0200
committerKristian Evers <kristianevers@gmail.com>2018-05-23 13:41:08 +0200
commitf5c8188faa44ba8dbae533c295d6ae013422f3b9 (patch)
treee98d10ce0ea6dafb2caf101a1eadc8fd67c8952b /docs/source/development/reference/functions.rst
parent58cbb9fe4f89b9febd780f7bdcfa4c2bb74a723e (diff)
parent37ebb8f9f0cc5083d22f84433fb2de0fdde8be00 (diff)
downloadPROJ-f5c8188faa44ba8dbae533c295d6ae013422f3b9.tar.gz
PROJ-f5c8188faa44ba8dbae533c295d6ae013422f3b9.zip
Merge branch 'master' into return-nans-quickly
Diffstat (limited to 'docs/source/development/reference/functions.rst')
-rw-r--r--docs/source/development/reference/functions.rst7
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/source/development/reference/functions.rst b/docs/source/development/reference/functions.rst
index 52f801e5..e6a54cba 100644
--- a/docs/source/development/reference/functions.rst
+++ b/docs/source/development/reference/functions.rst
@@ -386,16 +386,19 @@ Distances
.. c:function:: double proj_lp_dist(const PJ *P, PJ_COORD a, PJ_COORD b)
- Calculate geodesic distance between two points in geodetic coordinates.
+ Calculate geodesic distance between two points in geodetic coordinates. The
+ calculated distance is between the two points located on the ellipsoid.
:param PJ* P: Transformation object
:param PJ_COORD a: Coordinate of first point
:param PJ_COORD b: Coordinate of second point
:returns: :c:type:`double` Distance between :c:data:`a` and :c:data:`b` in meters.
-.. c:function:: double proj_lp_dist(const PJ *P, PJ_COORD a, PJ_COORD b)
+.. c:function:: double proj_lpz_dist(const PJ *P, PJ_COORD a, PJ_COORD b)
Calculate geodesic distance between two points in geodetic coordinates.
+ Similar to :c:func:`proj_lp_dist` but also takes the height above the ellipsoid
+ into account.
:param PJ* P: Transformation object
:param PJ_COORD a: Coordinate of first point