From: Sandro Santilli Date: Mon, 23 Feb 2015 10:12:54 +0000 (+0000) Subject: Further reword docs for <-> and <#> operators X-Git-Tag: 2.2.0rc1~644 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=1f34cab079c7610890f6932daa5455eda39a2cf5;p=postgis Further reword docs for <-> and <#> operators .. makeing clear KNN is only available with PgSQL 9.1+ git-svn-id: http://svn.osgeo.org/postgis/trunk@13266 b70326c6-7e19-0410-871a-916f4a2858ee --- diff --git a/doc/reference_operator.xml b/doc/reference_operator.xml index a89249f0c..9c2e63bea 100644 --- a/doc/reference_operator.xml +++ b/doc/reference_operator.xml @@ -1109,7 +1109,7 @@ ordering. 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 Refer to OpenGeo workshop: Nearest-Neighbour Searching for real live example. - Availability: 2.0.0 only available for PostgreSQL 9.1+ + Availability: 2.0.0 -- KNN only available for PostgreSQL 9.1+ @@ -1196,8 +1196,9 @@ Finally the hybrid: <#> - Returns the distance between bounding box of 2 geometries. For point / point checks it's almost the same as distance (though may be different since the bounding box is at floating point accuracy and geometries are double precision). Useful for doing distance ordering and nearest neighbor limits - using KNN gist functionality. + +Returns the 2D distance between bounding boxes of 2 geometries. + @@ -1223,14 +1224,14 @@ Finally the hybrid: Description - The <#> KNN GIST operator returns distance between two floating point bounding boxes read from the spatial index if available. Useful for doing nearest neighbor approximate distance ordering. + The <#> operator returns distance between two floating point bounding boxes, possibly reading them from a spatial index (PostgreSQL 9.1+ required). Useful for doing nearest neighbor approximate distance ordering. This operand will make use of any 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 e.g. ORDER BY (ST_GeomFromText('POINT(1 2)') <#> geom) instead of g1.geom <#>. - Availability: 2.0.0 only available for PostgreSQL 9.1+ + Availability: 2.0.0 -- KNN only available for PostgreSQL 9.1+