From: Sandro Santilli Date: Wed, 10 Jun 2015 16:42:49 +0000 (+0000) Subject: Trim refpurpose section for <-> operator, move details down X-Git-Tag: 2.2.0rc1~379 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=793686af129ba7f2ea95b152130b5f1906c2b8fa;p=postgis Trim refpurpose section for <-> operator, move details down git-svn-id: http://svn.osgeo.org/postgis/trunk@13642 b70326c6-7e19-0410-871a-916f4a2858ee --- diff --git a/doc/reference_operator.xml b/doc/reference_operator.xml index 14f651226..812f173b4 100644 --- a/doc/reference_operator.xml +++ b/doc/reference_operator.xml @@ -1069,7 +1069,7 @@ select 'LINESTRING(0 0, 1 1)'::geometry ~= 'LINESTRING(0 1, 1 0)'::geometry as e <-> -Returns the 2D distance between A and B. Used in the "ORDER BY" clause to provide index-assisted nearest-neighbor result sets. For PostgreSQL below 9.5 only gives centroid distance of bounding boxes and for PostgreSQL 9.5+, does true KNN distance search giving true distance between geometries, and distance sphere for geographies +Returns the 2D distance between A and B. @@ -1113,8 +1113,13 @@ Returns the 2D distance between A and B. Used in the "ORDER BY" clause to provid Description -The <-> operator returns the 2D distance between two geometries. Useful for doing -nearest neighbor distance ordering. +The <-> operator returns the 2D distance between +two geometries. Used in the "ORDER BY" clause provides index-assisted +nearest-neighbor result sets. For PostgreSQL below 9.5 only gives +centroid distance of bounding boxes and for PostgreSQL 9.5+, does true +KNN distance search giving true distance between geometries, and distance +sphere for geographies. + This operand will make use of 2D GiST indexes that may be available on the geometries. It is different from other operators that use spatial indexes in that the spatial index is only used when the operator is in the ORDER BY clause. Index only kicks in if one of the geometries is a constant (not in a subquery/cte). e.g. 'SRID=3005;POINT(1011102 450541)'::geometry instead of a.geom