[postgis-commits] svn - r2962 - trunk/doc

[postgis-commits at postgis.refractions.net]

Author: kneufeld
Date: 2008-09-12 22:41:33 -0700 (Fri, 12 Sep 2008)
New Revision: 2962

Modified:
   trunk/doc/reference.xml
   trunk/doc/reference_new.xml
Log:
Moved over ST_IsRing to new PostGIS reference.  
Fixed link errors to ST_IsSimple.

Modified: trunk/doc/reference.xml
===================================================================
--- trunk/doc/reference.xml	2008-09-12 19:45:19 UTC (rev 2961)
+++ trunk/doc/reference.xml	2008-09-13 05:41:33 UTC (rev 2962)
@@ -241,7 +241,7 @@
           </listitem>
         </varlistentry>
 
-        <varlistentry id="IsSimple">
+        <varlistentry id="ST_IsSimple">
           <term>ST_IsSimple(geometry)</term>
 
           <listitem>
@@ -255,20 +255,6 @@
         </varlistentry>
 
         <varlistentry>
-          <term>ST_IsRing(geometry)</term>
-
-          <listitem>
-            <para>Returns 1 (TRUE) if this Curve is closed (StartPoint ( ) =
-            EndPoint ( )) and this Curve is simple (does not pass through the
-            same point more than once).</para>
-
-            <para>performed by GEOS</para>
-
-            <para>OGC spec 2.1.5.1</para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry>
           <term>ST_NumGeometries(geometry)</term>
 
           <listitem>
@@ -1263,7 +1249,7 @@
             any kind of geometry. Since simplification occurs on a
             object-by-object basis you can also feed a GeometryCollection to
             this function. Note that returned geometry might loose its
-            simplicity (see <link linkend="IsSimple">IsSimple</link>)</para>
+            simplicity (see <xref linkend="ST_IsSimple" />)</para>
           </listitem>
         </varlistentry>
 
@@ -1293,7 +1279,7 @@
 
             <note>
               <para>The returned geometry might loose its simplicity (see
-              <link linkend="IsSimple">IsSimple</link>).</para>
+              <xref linkend="ST_IsSimple" />).</para>
             </note>
 
             <note>
@@ -1894,22 +1880,7 @@
         </listitem>
       </varlistentry>
 
-      <varlistentry id="ST_IsRing">
-        <term>ST_IsRing</term>
-
-        <listitem>
-          <para>Test if an ST_Curve value is a ring.</para>
-
-          <note>
-            <para>SQL-MM defines the result of ST_IsRing(NULL) to be 0, while
-            PostGIS returns NULL.</para>
-          </note>
-
-          <para>SQL-MM 3: 7.1.6</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry >
+      <varlistentry>
         <term>ST_IsSimple</term>
 
         <listitem>

Modified: trunk/doc/reference_new.xml
===================================================================
--- trunk/doc/reference_new.xml	2008-09-12 19:45:19 UTC (rev 2961)
+++ trunk/doc/reference_new.xml	2008-09-13 05:41:33 UTC (rev 2962)
@@ -2213,6 +2213,83 @@
 	  </refsection>
 	</refentry>
 	
+  <refentry id="ST_IsRing">
+    <refnamediv>
+      <refname>ST_IsRing</refname>
+  
+      <refpurpose>Returns <varname>TRUE</varname> if this
+      <varname>LINESTRING</varname> is both closed and simple.</refpurpose>
+    </refnamediv>
+  
+    <refsynopsisdiv>
+      <funcsynopsis>
+        <funcprototype>
+          <funcdef>boolean <function>ST_IsRing</function></funcdef>
+  
+          <paramdef><type>geometry </type> <parameter>g</parameter></paramdef>
+        </funcprototype>
+      </funcsynopsis>
+    </refsynopsisdiv>
+  
+    <refsection>
+      <title>Description</title>
+  
+      <para>Returns <varname>TRUE</varname> if this
+      <varname>LINESTRING</varname> is both <xref linkend="ST_IsClosed" />
+      (<function>ST_StartPoint(<parameter>g</parameter>)</function>
+      <function>~=</function>
+      <function>ST_Endpoint(<parameter>g</parameter>)</function>) and <xref
+      linkend="ST_IsSimple" /> (does not self intersect).</para>
+  
+      <para><inlinemediaobject>
+          <imageobject>
+            <imagedata fileref="images/check.png" />
+          </imageobject>
+        </inlinemediaobject> This method implements the <ulink
+      url="http://www.opengeospatial.org/standards/sfs">OpenGIS Simple Features
+      Implementation Specification for SQL.</ulink> OGC SFSQL 1.1 -
+      2.1.5.1</para>
+  
+      <para><inlinemediaobject>
+          <imageobject>
+            <imagedata fileref="images/check.png" />
+          </imageobject>
+        </inlinemediaobject> This method implements the SQL/MM specification:
+      SQL-MM 3: 7.1.6</para>
+  
+      <note>
+        <para>SQL-MM defines the result of
+        <function>ST_IsRing(<varname>NULL</varname>)</function> to be 0, while
+        PostGIS returns <varname>NULL</varname>.</para>
+      </note>
+    </refsection>
+  
+    <refsection>
+      <title>Examples</title>
+  
+      <programlisting>SELECT ST_IsRing(the_geom), ST_IsClosed(the_geom), ST_IsSimple(the_geom)
+FROM (SELECT 'LINESTRING(0 0, 0 1, 1 1, 1 0, 0 0)'::geometry AS the_geom) AS foo;
+ st_isring | st_isclosed | st_issimple
+-----------+-------------+-------------
+ t         | t           | t
+(1 row)
+
+SELECT ST_IsRing(the_geom), ST_IsClosed(the_geom), ST_IsSimple(the_geom)
+FROM (SELECT 'LINESTRING(0 0, 0 1, 1 0, 1 1, 0 0)'::geometry AS the_geom) AS foo;
+ st_isring | st_isclosed | st_issimple
+-----------+-------------+-------------
+ f         | t           | f
+(1 row)</programlisting>
+    </refsection>
+  
+    <refsection>
+      <title>See Also</title>
+  
+      <para><xref linkend="ST_IsClosed" />, <xref linkend="ST_IsSimple" />, <xref linkend="ST_StartPoint" />,
+      <xref linkend="ST_EndPoint" /></para>
+    </refsection>
+  </refentry>
+
 	<refentry id="ST_SRID">
 	  <refnamediv>
 		<refname>ST_SRID</refname>