[postgis-tickets] [SCM] PostGIS branch master updated. 3.1.0alpha3-29-g30eefa8
git at osgeo.org
git at osgeo.org
Sun Dec 6 17:49:52 PST 2020
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "PostGIS".
The branch, master has been updated
via 30eefa8b735d8e81e8414d0a3de8a775c1bf5ef7 (commit)
from 021409932786bf4fa5a2b6f98864349a84e0d515 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 30eefa8b735d8e81e8414d0a3de8a775c1bf5ef7
Author: Martin Davis <mtnclimb at gmail.com>
Date: Sun Dec 6 17:49:42 2020 -0800
Improve Doc Ref descriptions
diff --git a/doc/reference_processing.xml b/doc/reference_processing.xml
index f5562b4..f920431 100644
--- a/doc/reference_processing.xml
+++ b/doc/reference_processing.xml
@@ -878,7 +878,7 @@ SELECT d.disease_type,
<refname>ST_DelaunayTriangles</refname>
<refpurpose>
-Returns a Delaunay triangulation around the given input points.
+Returns the Delaunay triangulation of the vertices of a geometry.
</refpurpose>
</refnamediv>
@@ -897,12 +897,12 @@ Returns a Delaunay triangulation around the given input points.
<title>Description</title>
<para>
-Return a <ulink
+Return the <ulink
url="http://en.wikipedia.org/wiki/Delaunay_triangulation">Delaunay
-triangulation</ulink> around the vertices of the input geometry.
+triangulation</ulink> of the vertices of the input geometry.
Output is a COLLECTION of polygons (for flags=0) or a MULTILINESTRING
(for flags=1) or TIN (for flags=2). The tolerance, if any, is used to snap input vertices
-togheter.
+together.
</para>
<para>Performed by the GEOS module.</para>
<para>Availability: 2.1.0</para>
diff --git a/doc/reference_relationship.xml b/doc/reference_relationship.xml
index 7c75052..c75bc0d 100644
--- a/doc/reference_relationship.xml
+++ b/doc/reference_relationship.xml
@@ -14,8 +14,8 @@
<refnamediv>
<refname>ST_3DIntersects</refname>
- <refpurpose>Returns TRUE if the Geometries "spatially
- intersect" in 3D - only for points, linestrings, polygons, polyhedral surface (area).
+ <refpurpose>Returns true if two geometries spatially
+ intersect in 3D - only for points, linestrings, polygons, polyhedral surface (area).
</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -359,8 +359,7 @@ ST_Point | t | t | f | f
<refnamediv>
<refname>ST_Covers</refname>
- <refpurpose>Returns 1 (TRUE) if no point in Geometry B is outside
- Geometry A</refpurpose>
+ <refpurpose>Returns true if no point in B is outside A</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -459,7 +458,7 @@ SELECT ST_Covers(geog_poly, geog_pt) As poly_covers_pt,
<refnamediv>
<refname>ST_CoveredBy</refname>
- <refpurpose>Returns 1 (TRUE) if no point in Geometry/Geography A is outside
+ <refpurpose>Returns true if no point in Geometry/Geography A is outside
Geometry/Geography B</refpurpose>
</refnamediv>
@@ -542,7 +541,7 @@ FROM (SELECT ST_Buffer(ST_GeomFromText('POINT(1 2)'), 10) As smallc,
<refnamediv>
<refname>ST_Crosses</refname>
- <refpurpose>Returns <varname>TRUE</varname> if the supplied geometries have some, but not all,
+ <refpurpose>Returns true if two geometries have some, but not all,
interior points in common.</refpurpose>
</refnamediv>
@@ -721,7 +720,7 @@ WHERE ST_Crosses(roads.the_geom, highways.the_geom);</programlisting>
<refnamediv>
<refname>ST_LineCrossingDirection</refname>
- <refpurpose>Given 2 linestrings, returns a number between -3 and 3 denoting what kind of crossing behavior. 0 is no crossing.</refpurpose>
+ <refpurpose>Returns a number indicating the crossing behavior of two LineStrings.</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -737,8 +736,12 @@ WHERE ST_Crosses(roads.the_geom, highways.the_geom);</programlisting>
<refsection>
<title>Description</title>
- <para>Given 2 linestrings, returns a number between -3 and 3 denoting what kind of crossing behavior. 0 is no crossing. This is only supported for <varname>LINESTRING</varname></para>
- <para>Definition of integer constants is as follows:
+ <para>Given 2 linestrings, returns an integer between -3 and 3
+ indicating what kind of crossing behavior exists between them.
+ 0 indicates no crossing.
+ This is only supported for <varname>LINESTRING</varname>s.
+ </para>
+ <para>The crossing number has the following meaning:
<itemizedlist>
<listitem>
<para> 0: LINE NO CROSS</para>
@@ -902,8 +905,8 @@ WHERE ST_CrossingDirection(s1.the_geom, s2.the_geom) > 0;
<refnamediv>
<refname>ST_Disjoint</refname>
- <refpurpose>Returns TRUE if the Geometries do not "spatially
- intersect" - if they do not share any space together.
+ <refpurpose>Returns true if two geometries do not spatially
+ intersect (they have no point in common).
</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -970,8 +973,7 @@ SELECT ST_Disjoint('POINT(0 0)'::geometry, 'LINESTRING ( 0 0, 0 2 )'::geometry);
<refnamediv>
<refname>ST_Equals</refname>
- <refpurpose>Returns true if the given geometries represent the same geometry. Directionality
- is ignored.</refpurpose>
+ <refpurpose>Returns true if two geometries include the same set of points in space.</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -1040,9 +1042,8 @@ SELECT ST_Equals(ST_Reverse(ST_GeomFromText('LINESTRING(0 0, 10 10)')),
<refnamediv>
<refname>ST_Intersects</refname>
- <refpurpose>Returns TRUE if the Geometries/Geography "spatially
- intersects in 2D" - (share any portion of space) and FALSE if they don't (they are Disjoint).
- For geography tolerance is 0.00001 meters (so any points that close are considered to intersect)
+ <refpurpose>Returns true if two Geometries/Geography spatially
+ intersect in 2D (have at least one point in common).
</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -1149,8 +1150,8 @@ t
<refnamediv>
<refname>ST_OrderingEquals</refname>
- <refpurpose>Returns true if the given geometries represent the same geometry
- and points are in the same directional order.</refpurpose>
+ <refpurpose>Returns true if two geometries represent the same geometry
+ and have points in the same directional order.</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -1213,7 +1214,7 @@ SELECT ST_OrderingEquals(ST_Reverse(ST_GeomFromText('LINESTRING(0 0, 10 10)')),
<refnamediv>
<refname>ST_Overlaps</refname>
- <refpurpose>Returns TRUE if the Geometries share space, are of the same dimension, but are not completely contained by each other.</refpurpose>
+ <refpurpose>Returns true if two geometries intersect and have the same dimension, but are not completely contained by each other.</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -1343,11 +1344,10 @@ FROM (SELECT ST_Buffer(ST_GeomFromText('POINT(1 0.5)'), 3) As a,
<refnamediv>
<refname>ST_Relate</refname>
- <refpurpose>Returns true if this Geometry is spatially related to
- anotherGeometry, by testing for intersections between the
- Interior, Boundary and Exterior of the two geometries as specified
- by the values in the intersectionMatrixPattern. If no intersectionMatrixPattern
- is passed in, then returns the maximum intersectionMatrixPattern that relates the 2 geometries.</refpurpose>
+ <refpurpose>Tests if two geometries have a topological relationship
+ matching a given Intersection Matrix pattern,
+ or computes their Intersection Matrix
+ </refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -1377,24 +1377,29 @@ FROM (SELECT ST_Buffer(ST_GeomFromText('POINT(1 0.5)'), 3) As a,
<refsection>
<title>Description</title>
- <para>Version 1: Takes geomA, geomB, intersectionMatrix and Returns 1 (TRUE) if this Geometry is spatially related to
- anotherGeometry, by testing for intersections between the
+ <para>Variant 1: Tests if two geometries are spatially related
+ according to the given <varname>intersectionMatrixPattern</varname>, by testing for intersections between the
Interior, Boundary and Exterior of the two geometries as specified
by the values in the <ulink url="http://en.wikipedia.org/wiki/DE-9IM">DE-9IM matrix pattern</ulink>.</para>
- <para>This is especially useful for testing compound checks of intersection, crosses, etc in one step.</para>
+ <para>This is useful for testing multiple conditions of intersection, crosses, etc in one step.
+ It also allows testing spatial relationships which do not have a named pattern
+ (for example, "interior-intersects" which has the pattern <code>T********</code>).
+ </para>
<note><para>This is the "allowable" version that returns a
boolean, not an integer. This is defined in OGC spec</para></note>
- <note><para>This DOES NOT automagically include an index call. The reason for that
- is some relationships are anti e.g. Disjoint. If you are
+ <note><para>This does NOT automatically include an index call.
+ The reason is that some relationships are true for geometries
+ whose extents do NOT intersect (e.g. Disjoint). If you are
using a relationship pattern that requires intersection, then include the &&
index call.</para></note>
- <para>Version 2: Takes geomA and geomB and returns the <xref linkend="DE-9IM" /></para>
+ <para>Variant 2: Returns the <xref linkend="DE-9IM" /> matrix string for the
+ relationship between the two inputs</para>
- <para>Version 3: same as version 2, but allows to specify a boundary node rule (1:OGC/MOD2, 2:Endpoint, 3:MultivalentEndpoint, 4:MonovalentEndpoint)</para>
+ <para>Variant 3: same as variant 2, but allows specifying a boundary node rule (1:OGC/MOD2, 2:Endpoint, 3:MultivalentEndpoint, 4:MonovalentEndpoint)</para>
<important>
<para>Enhanced: 3.0.0 enabled support for <varname>GEOMETRYCOLLECTION</varname></para>
@@ -1453,7 +1458,7 @@ t
<refnamediv>
<refname>ST_RelateMatch</refname>
- <refpurpose>Returns true if intersectionMattrixPattern1 implies intersectionMatrixPattern2</refpurpose>
+ <refpurpose>Returns true if an Intersection Matrix value matches an Intersection Matrix pattern</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -1469,8 +1474,9 @@ t
<refsection>
<title>Description</title>
- <para> Takes intersectionMatrix and intersectionMatrixPattern and Returns true if the intersectionMatrix satisfies
- the intersectionMatrixPattern. For more information refer to <xref linkend="DE-9IM" />. </para>
+ <para> Tests if an <varname>intersectionMatrix</varname> value satisfies
+ an <varname>intersectionMatrixPattern</varname>.
+ For more information refer to <xref linkend="DE-9IM" />. </para>
<para>Performed by the GEOS module</para>
<para>Availability: 2.0.0</para>
</refsection>
@@ -1510,7 +1516,7 @@ SELECT mat.name, pat.name, ST_RelateMatch(mat.val, pat.val) As satisfied
<refnamediv>
<refname>ST_Touches</refname>
- <refpurpose>Returns <varname>TRUE</varname> if the geometries have at least one point in common,
+ <refpurpose>Returns true if two geometries have at least one point in common,
but their interiors do not intersect.</refpurpose>
</refnamediv>
@@ -1669,7 +1675,7 @@ SELECT ST_Touches('LINESTRING(0 0, 1 1, 0 2)'::geometry, 'POINT(0 2)'::geometry)
<refnamediv>
<refname>ST_Within</refname>
- <refpurpose>Returns true if the geometry A is completely inside geometry B</refpurpose>
+ <refpurpose>Returns true if geometry A is completely inside geometry B</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -1764,7 +1770,7 @@ SELECT ST_Buffer(ST_GeomFromText('POINT(50 50)'), 20) As smallc,
<refnamediv>
<refname>ST_3DDWithin</refname>
- <refpurpose>For 3d (z) geometry type Returns true if two geometries 3d distance is within number of units. </refpurpose>
+ <refpurpose>Returns true if two 3D geometries are within a given 3D distance</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
@@ -1831,8 +1837,7 @@ ST_DWithin(
<refnamediv>
<refname>ST_3DDFullyWithin</refname>
- <refpurpose>Returns true if all of the 3D geometries are within the specified
- distance of one another. </refpurpose>
+ <refpurpose>Returns true if two 3D geometries are entirely within a given 3D distance</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -1900,8 +1905,7 @@ ST_DWithin(
<refnamediv>
<refname>ST_DFullyWithin</refname>
- <refpurpose>Returns true if all of the geometries are within the specified
- distance of one another</refpurpose>
+ <refpurpose>Returns true if two geometries are entirely within a given distance</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -1924,7 +1928,7 @@ ST_DWithin(
<refsection>
<title>Description</title>
- <para>Returns true if the geometries is fully within the specified distance
+ <para>Returns true if the geometries are entirely within the specified distance
of one another. The distance is specified in units defined by the
spatial reference system of the geometries. For this function to make
sense, the source geometries must both be of the same coordinate projection,
@@ -1961,9 +1965,7 @@ ST_DWithin(
<refnamediv>
<refname>ST_DWithin</refname>
- <refpurpose>Returns true if the geometries are within the specified
- distance of one another. For geometry units are in those of spatial reference and for geography units are in meters and measurement is
- defaulted to use_spheroid=true (measure around spheroid), for faster check, use_spheroid=false to measure along sphere.</refpurpose>
+ <refpurpose>Returns true if two geometries are within a given distance</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -2000,8 +2002,7 @@ ST_DWithin(
<refsection>
<title>Description</title>
- <para>Returns true if the geometries are within the specified distance
- of one another.</para>
+ <para>Returns true if the geometries are within a given distance</para>
<para>For <type>geometry</type>: The distance is specified in units defined by the
spatial reference system of the geometries. For this function to make
@@ -2084,7 +2085,7 @@ SELECT b.tower_id, b.geom
<refnamediv>
<refname>ST_PointInsideCircle</refname>
- <refpurpose>Is the point geometry inside the circle defined by center_x, center_y, radius</refpurpose>
+ <refpurpose>Tests if a point geometry is inside a circle defined by a center and radius.</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -2102,12 +2103,11 @@ SELECT b.tower_id, b.geom
<refsection>
<title>Description</title>
- <para>The syntax for this functions is
- ST_PointInsideCircle(<geometry>,<circle_center_x>,<circle_center_y>,<radius>).
- Returns the true if the geometry is a point and is inside the
- circle. Returns false otherwise.</para>
- <warning><para>Will not use spatial indexes. Use <xref linkend="ST_DWithin" /> instead.</para></warning>
- <note><para>This only works for points as the name suggests.</para></note>
+ <para>Returns true if the geometry is a point and is inside the
+ circle with center <varname>center_x</varname>,<varname>center_y</varname>
+ and radius <varname>radius</varname>.
+ </para>
+ <warning><para>Does use spatial indexes. Use <xref linkend="ST_DWithin" /> instead.</para></warning>
<para>Availability: 1.2</para>
<para>Changed: 2.2.0 In prior versions this used to be called ST_Point_Inside_Circle</para>
-----------------------------------------------------------------------
Summary of changes:
doc/reference_processing.xml | 8 +--
doc/reference_relationship.xml | 108 ++++++++++++++++++++---------------------
2 files changed, 58 insertions(+), 58 deletions(-)
hooks/post-receive
--
PostGIS
More information about the postgis-tickets
mailing list