]> granicus.if.org Git - postgis/commitdiff
Document ST_Node (#1206)
authorSandro Santilli <strk@keybit.net>
Fri, 4 Nov 2011 18:48:14 +0000 (18:48 +0000)
committerSandro Santilli <strk@keybit.net>
Fri, 4 Nov 2011 18:48:14 +0000 (18:48 +0000)
git-svn-id: http://svn.osgeo.org/postgis/trunk@8094 b70326c6-7e19-0410-871a-916f4a2858ee

doc/reference_processing.xml

index 45dfdb6ac3bb835efa5b12ee2d577e38fb2a6117..c33fa09fe0e059e48549b8b231cf01509bce855f 100644 (file)
@@ -2812,6 +2812,54 @@ MULTILINESTRING((3 4,4 5),(1 2,3 4))
          </refsection>
        </refentry>
 
+       <refentry id="ST_Node">
+         <refnamediv>
+               <refname>ST_Node</refname>
+
+               <refpurpose>
+Node a set of linestrings.
+               </refpurpose>
+         </refnamediv>
+
+         <refsynopsisdiv>
+               <funcsynopsis>
+                 <funcprototype>
+                       <funcdef>geometry <function>ST_Node</function></funcdef>
+                       <paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
+                 </funcprototype>
+
+               </funcsynopsis>
+         </refsynopsisdiv>
+
+         <refsection>
+               <title>Description</title>
+
+               <para>
+Fully node a set of linestrings using the least possible number of nodes
+while preserving all of the input ones.
+               </para>
+
+               <para>&Z_support;</para>
+
+               <para>Availability: 2.0.0 - requires GEOS &gt;= 3.3.0.</para>
+
+               <note><para>
+Due to a bug in GEOS up to 3.3.1 this function fails to node self-intersecting
+lines. This is fixed with GEOS 3.3.2 or higher.
+               </para></note>
+         </refsection>
+
+
+         <!-- Optionally add a "See Also" section -->
+         <refsection>
+               <title>See Also</title>
+
+               <para>
+                       <xref linkend="ST_UnaryUnion" />
+               </para>
+         </refsection>
+       </refentry>
+
 
 
 </sect1>