[postgis-tickets] [SCM] PostGIS branch master updated. 3.3.0rc2-755-g92b757418
git at osgeo.org
git at osgeo.org
Thu May 4 18:02:09 PDT 2023
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 92b7574189989702147ee663a7c33f03008f2d8a (commit)
via b4f7aa8377b97be5dddc37031dc9854b63a4f059 (commit)
via 5739cd98bcc546de888c87ff187bc6c7975c0b13 (commit)
from 41a3acb8dbabb93986a9c4d0a484f780e3035351 (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 92b7574189989702147ee663a7c33f03008f2d8a
Merge: b4f7aa837 41a3acb8d
Author: Martin Davis <mtnclimb at gmail.com>
Date: Thu May 4 18:02:05 2023 -0700
Merge branch 'master' of https://git.osgeo.org/gitea/postgis/postgis
commit b4f7aa8377b97be5dddc37031dc9854b63a4f059
Author: Martin Davis <mtnclimb at gmail.com>
Date: Thu May 4 18:02:03 2023 -0700
Improve doc for function lists
diff --git a/doc/xsl/postgis_aggs_mm.xml.xsl b/doc/xsl/postgis_aggs_mm.xml.xsl
index 19131b8b0..c8fb63ca1 100644
--- a/doc/xsl/postgis_aggs_mm.xml.xsl
+++ b/doc/xsl/postgis_aggs_mm.xml.xsl
@@ -20,7 +20,7 @@
<title>PostGIS Special Functions Index</title>
<sect1 id="PostGIS_Aggregate_Functions">
<title>PostGIS Aggregate Functions</title>
- <para>The functions given below are spatial aggregate functions provided with PostGIS that can be used just like any other sql aggregate function such as sum, average.</para>
+ <para>The functions below are spatial aggregate functions that are used in the same way as SQL aggregate function such as <code>sum</code> and <code>average</code>.</para>
<itemizedlist>
<!-- Pull out the purpose section for each ref entry and strip whitespace and put in a variable to be tagged unto each function comment -->
<xsl:for-each select='//refentry'>
@@ -47,7 +47,7 @@
<sect1 id="PostGIS_Window_Functions">
<title>PostGIS Window Functions</title>
- <para>The functions given below are spatial window functions provided with PostGIS that can be used just like any other sql window function such as row_numer(), lead(), lag(). All these require an SQL OVER() clause.</para>
+ <para>The functions below are spatial window functions that are used in the same way as SQL window functions such as <code>row_number()</code>, <code>lead()</code>, and <code>lag()</code>. They must be followed by an <code>OVER()</code> clause.</para>
<xsl:if test="//funcprototype[contains(paramdef/type,' winset')]">
<itemizedlist>
<!-- Pull out the purpose section for each ref entry and strip whitespace and put in a variable to be tagged unto each function comment -->
commit 5739cd98bcc546de888c87ff187bc6c7975c0b13
Author: Martin Davis <mtnclimb at gmail.com>
Date: Thu May 4 18:01:43 2023 -0700
Improve doc for coverage functions
diff --git a/doc/reference_coverage.xml b/doc/reference_coverage.xml
index 846144fe1..8b502418b 100644
--- a/doc/reference_coverage.xml
+++ b/doc/reference_coverage.xml
@@ -2,7 +2,9 @@
<sect1 id="Coverage">
<sect1info>
<abstract>
- <para>These functions operate on collections of polygonal geometry that form "implicit coverages" in which any edges shared by the polygons match exactly. These implicit coverages are fast to process, and can be operated on with window functions, which retain the implicit topology inside the window partition while altering the edges.</para>
+ <para>These functions operate on sets of polygonal geometry that form "implicit coverages".
+ To form a valid coverage polygons must not overlap, and the vertices of adjacent edges must match exactly.
+ Coverages are fast to process, and can be operated on with window functions, which retain the coverage topology inside the window partition while altering the edges.</para>
</abstract>
</sect1info>
@@ -12,7 +14,7 @@
<refnamediv>
<refname>ST_CoverageInvalidLocations</refname>
- <refpurpose>Window function that determines if a set of polygons form a valid polygonal coverage.</refpurpose>
+ <refpurpose>Window function that finds locations where polygons fail to form a valid coverage.</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -31,7 +33,7 @@
<title>Description</title>
<para>Checks if the polygons in the window partition form a valid polygonal coverage,
- and returns linear indicators showing the location of invalid edges in each polygon.
+ and returns linear indicators showing the location of invalid edges (if any) in each polygon.
</para>
<para>A set of polygons is a valid coverage if the following conditions hold:
</para>
@@ -45,7 +47,7 @@
</para></listitem>
</itemizedlist>
- <para>As a window function, a value is returned for every input polygon.
+ <para>As a window function a value is returned for every input polygon.
For polygons which violate one or more of the validity conditions the return value is a MULTILINESTRING containing the problematic edges.
Valid polygons return the value NULL.
Non-polygonal or empty geometries also produce NULL values.</para>
@@ -103,7 +105,7 @@ SELECT true = ALL (
<refnamediv>
<refname>ST_CoverageSimplify</refname>
- <refpurpose>Window function that simplifies the edges of an implicit polygonal coverage, using the Visvalingam–Whyatt algorithm.</refpurpose>
+ <refpurpose>Window function that simplifies the edges of a polygonal coverage.</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -124,9 +126,11 @@ SELECT true = ALL (
<title>Description</title>
<para>A window function which simplifies the edges of polygons in a polygonal coverage using the <ulink url="https://en.wikipedia.org/wiki/Visvalingam%E2%80%93Whyatt_algorithm">Visvalingam–Whyatt algorithm</ulink>.
- For inputs forming a valid polygonal coverage the simplified outputs are consisent along shared edges, and still form a valid coverage.</para>
+ The simplified outputs are consisent along shared edges, and still form a valid coverage.</para>
+ <note><para>If the input is not a valid coverage there may be unexpected artifacts in the output (such as boundary intersections, or separated boundaries which appeared to be shared).
+ Use <xref linkend="ST_CoverageInvalidLocations" /> to determine if a coverage is valid.
+ </para></note>
<para>To simplify only the "internal" edges of the coverage (those that are shared by two polygons) set the <parameter>simplifyBoundary</parameter> parameter to false.</para>
- <note><para>If the input is not a valid coverage there may be unexpected artifacts in the output (such as boundary intersections, or separated boundaries which appeared to be shared).</para></note>
<para>Availability: 3.4.0 - requires GEOS >= 3.12.0</para>
</refsection>
@@ -155,7 +159,6 @@ SELECT id, ST_AsText(ST_CoverageSimplify(geom, 1.0) OVER ())
<refsection>
<title>See Also</title>
<para>
- <xref linkend="ST_CoverageUnion" />,
<xref linkend="ST_CoverageInvalidLocations" />
</para>
</refsection>
@@ -166,7 +169,7 @@ SELECT id, ST_AsText(ST_CoverageSimplify(geom, 1.0) OVER ())
<refnamediv>
<refname>ST_CoverageUnion</refname>
- <refpurpose>Unions a set of polygons forming a coverage by removing shared edges.</refpurpose>
+ <refpurpose>Computes the union of a set of polygons forming a coverage by removing shared edges.</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -182,10 +185,15 @@ SELECT id, ST_AsText(ST_CoverageSimplify(geom, 1.0) OVER ())
<refsection>
<title>Description</title>
- <para>An aggregate function which performs a high-speed union of a set of polygons forming a polygonal coverage.
- This function only works with inputs that are coverages: no overlaps, and all shared edges identical down to the vertex level. See <xref linkend="ST_CoverageInvalidLocations" /> for a way to test that a set of polygons are a valid polygonal coverage.</para>
+ <para>An aggregate function which unions a set of polygons forming a polygonal coverage.
+ The result is a polygonal geometry covering the same area as the coverage.
+ This function produces the same result as <xref linkend="ST_Union" />,
+ but uses the coverage structure to compute the union much faster.
+ </para>
- <note><para>If the input is not a valid coverage there may be unexpected artifacts in the output (such as unmerged or overlapping polygons).</para></note>
+ <note><para>If the input is not a valid coverage there may be unexpected artifacts in the output (such as unmerged or overlapping polygons).
+ Use <xref linkend="ST_CoverageInvalidLocations" /> to determine if a coverage is valid.
+ </para></note>
<para>Availability: 3.4.0 - requires GEOS >= 3.8.0</para>
</refsection>
@@ -212,8 +220,8 @@ SELECT ST_AsText(ST_CoverageUnion(geom))
<refsection>
<title>See Also</title>
<para>
- <xref linkend="ST_CoverageSimplify" />,
- <xref linkend="ST_CoverageInvalidLocations" />
+ <xref linkend="ST_CoverageInvalidLocations" />,
+ <xref linkend="ST_Union" />
</para>
</refsection>
-----------------------------------------------------------------------
Summary of changes:
doc/reference_coverage.xml | 36 ++++++++++++++++++++++--------------
doc/xsl/postgis_aggs_mm.xml.xsl | 4 ++--
2 files changed, 24 insertions(+), 16 deletions(-)
hooks/post-receive
--
PostGIS
More information about the postgis-tickets
mailing list