From: Sandro Santilli <strk@keybit.net>
Date: Thu, 7 Mar 2013 17:08:53 +0000 (+0000)
Subject: Document ST_Simplify(TopoGeometry) -- closes #1687
X-Git-Tag: 2.1.0beta2~177
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=7886e8b4b2b8dcfa7237933bd30e03496e4314c8;p=postgis

Document ST_Simplify(TopoGeometry) -- closes #1687

git-svn-id: http://svn.osgeo.org/postgis/trunk@11159 b70326c6-7e19-0410-871a-916f4a2858ee
---

diff --git a/NEWS b/NEWS
index 122be673c..f7f64057a 100644
--- a/NEWS
+++ b/NEWS
@@ -69,6 +69,7 @@ PostGIS 2.1.0
     accessible selectivity and stats reader functions for testing
   - #2210, ST_MinConvexHull(raster)
   - lwgeom_from_geojson in liblwgeom (Sandro Santilli / Vizzuality)
+  - #1687, ST_Simplify for TopoGeometry (Sandro Santilli / Vizzuality)
 
 * Enhancements *
   - #823,  tiger geocoder: Make loader_generate_script download portion 
diff --git a/doc/extras_topology.xml b/doc/extras_topology.xml
index d65cba727..1c41f3e7b 100644
--- a/doc/extras_topology.xml
+++ b/doc/extras_topology.xml
@@ -2444,6 +2444,41 @@ faceid
 			</refsection>
 		</refentry>
 
+	<refentry id="TP_ST_Simplify">
+	  <refnamediv>
+		<refname>ST_Simplify</refname>
+		<refpurpose>Returns a "simplified" version of the given geometry using
+				the Douglas-Peucker algorithm.</refpurpose>
+	  </refnamediv>
+
+	  <refsynopsisdiv>
+		<funcsynopsis>
+		  <funcprototype>
+			<funcdef>geometry <function>ST_Simplify</function></funcdef>
+			<paramdef><type>TopoGeometry</type> <parameter>geomA</parameter></paramdef>
+			<paramdef><type>float</type> <parameter>tolerance</parameter></paramdef>
+		  </funcprototype>
+		</funcsynopsis>
+	  </refsynopsisdiv>
+
+	  <refsection>
+		<title>Description</title>
+		<para>Returns a "simplified" version of the given TopoGeometry using
+				the Douglas-Peucker algorithm on each component edge.</para>
+
+		<note><para>The returned geometry may be non-simple or non-valid.</para>
+    <para>Splitting component edges may help retaining simplicity/validity.</para></note>
+
+		<para>Performed by the GEOS module.</para>
+		<para>Availability: 2.1.0</para>
+	  </refsection>
+
+		  <refsection>
+			<title>See Also</title>
+			<para>Geometry <xref linkend="ST_Simplify" />, <xref linkend="ST_IsSimple" />, <xref linkend="ST_IsValid" />, <xref linkend="ST_ModEdgeSplit" /></para>
+		  </refsection>
+	</refentry>
+
 		
 	</sect1>
 
diff --git a/doc/reference_processing.xml b/doc/reference_processing.xml
index e36f6e665..c6f8ed42d 100644
--- a/doc/reference_processing.xml
+++ b/doc/reference_processing.xml
@@ -2528,7 +2528,7 @@ FROM (SELECT ST_Buffer('POINT(1 3)', 10,12) As the_geom) As foo;
 		  </refsection>
 		  <refsection>
 			<title>See Also</title>
-			<para><xref linkend="ST_IsSimple" />, <xref linkend="ST_SimplifyPreserveTopology" /></para>
+			<para><xref linkend="ST_IsSimple" />, <xref linkend="ST_SimplifyPreserveTopology" />, Topology <xref linkend="TP_ST_Simplify"/></para>
 		  </refsection>
 	</refentry>