[postgis-commits] svn - r2857 - trunk/doc
postgis-commits at postgis.refractions.net
postgis-commits at postgis.refractions.net
Tue Jul 15 12:38:11 PDT 2008
Author: robe
Date: 2008-07-15 12:38:11 -0700 (Tue, 15 Jul 2008)
New Revision: 2857
Modified:
trunk/doc/reference.xml
trunk/doc/reference_new.xml
trunk/doc/template.xml
Log:
Move ST_Equals, ST_OrderingEquals - provide examples. Make Geometry - geometry
Modified: trunk/doc/reference.xml
===================================================================
--- trunk/doc/reference.xml 2008-07-15 18:02:06 UTC (rev 2856)
+++ trunk/doc/reference.xml 2008-07-15 19:38:11 UTC (rev 2857)
@@ -190,25 +190,6 @@
</varlistentry>
<varlistentry>
- <term>ST_Intersects(geometry, geometry)</term>
-
- <listitem>
- <para>Returns 1 (TRUE) if the Geometries "spatially
- intersect".</para>
-
- <para>Performed by the GEOS module</para>
-
- <para>Do not call with a GeometryCollection as an argument</para>
-
- <para>NOTE: this is the "allowable" version that returns a
- boolean, not an integer.</para>
-
- <para>OGC SPEC s2.1.1.2 // s2.1.13.3 - NOT disjoint(geometry,
- geometry)</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
<term>ST_Relate(geometry, geometry,
intersectionPatternMatrix)</term>
@@ -3176,24 +3157,7 @@
</listitem>
</varlistentry>
- <varlistentry>
- <term>ST_OrderingEquals</term>
- <listitem>
- <para>ST_OrderingEquals compares two geometries and t (TRUE) if the
- geometries are equal and the coordinates are in the same order;
- otherwise it returns f (FALSE).</para>
-
- <note>
- <para>This function is implemented as per the ArcSDE SQL
- specification rather than SQL-MM.
- http://edndoc.esri.com/arcsde/9.1/sql_api/sqlapi3.htm#ST_OrderingEquals</para>
- </note>
-
- <para>SQL-MM 3: 5.1.43</para>
- </listitem>
- </varlistentry>
-
<varlistentry>
<term>ST_Overlaps</term>
Modified: trunk/doc/reference_new.xml
===================================================================
--- trunk/doc/reference_new.xml 2008-07-15 18:02:06 UTC (rev 2856)
+++ trunk/doc/reference_new.xml 2008-07-15 19:38:11 UTC (rev 2857)
@@ -276,7 +276,7 @@
<refname>UpdateGeometrySRID</refname>
<refpurpose>Updates the SRID of all features in a geometry
- column and also corrects the geometry_columns table and corrects the geometry constraints on the table.</refpurpose>
+ column, geometry_columns metadata and srid table constraint</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -360,15 +360,15 @@
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
- <funcdef>Geometry <function>ST_MakeLine</function></funcdef>
- <paramdef><type>Geometry set</type> <parameter>pointfield</parameter></paramdef>
+ <funcdef>geometry <function>ST_MakeLine</function></funcdef>
+ <paramdef><type>geometry set</type> <parameter>pointfield</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<funcsynopsis>
<funcprototype>
- <funcdef>Geometry <function>ST_MakeLine</function></funcdef>
- <paramdef><type>Geometry</type> <parameter>point1</parameter></paramdef>
- <paramdef><type>Geometry</type> <parameter>point2</parameter></paramdef>
+ <funcdef>geometry <function>ST_MakeLine</function></funcdef>
+ <paramdef><type>geometry</type> <parameter>point1</parameter></paramdef>
+ <paramdef><type>geometry</type> <parameter>point2</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
@@ -676,7 +676,70 @@
<para><xref linkend="ST_Distance"/></para>
</refsection>
</refentry>
+
+ <refentry id="ST_Equals">
+ <refnamediv>
+ <refname>ST_Equals</refname>
+ <refpurpose>Returns true if the given geometries represent the same geometry. Directionality
+ is ignored.</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>boolean <function>ST_Equals</function></funcdef>
+ <paramdef><type>geometry </type> <parameter>A</parameter></paramdef>
+ <paramdef><type>geometry </type> <parameter>B</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+ <para>Returns TRUE if the given Geometries are "spatially
+ equal". Use this for a 'better' answer than '='.
+ Note by spatially equal we also mean ordering of points can be different but
+ represent the same geometry structure. To verify the order of points is consistent, use
+ ST_OrderingEquals.</para>
+
+ <para>
+ <inlinegraphic class="sfs_compliant" fileref="images/check.png" />
+ This method implements the
+ <ulink url="http://www.opengeospatial.org/standards/sfs">OpenGIS Simple
+ Features Implementation Specification for SQL OGC SPEC s2.1.1.2<</ulink>
+ </para>
+
+ </refsection>
+
+ <refsection>
+ <title>Examples</title>
+
+ <programlisting>SELECT ST_Equals(ST_GeomFromText('LINESTRING(0 0, 10 10)'),
+ ST_GeomFromText('LINESTRING(0 0, 5 5, 10 10)'));
+ st_equals
+-----------
+ t
+(1 row)
+
+SELECT ST_Equals(ST_Reverse(ST_GeomFromText('LINESTRING(0 0, 10 10)')),
+ ST_GeomFromText('LINESTRING(0 0, 5 5, 10 10)'));
+ st_equals
+-----------
+ t
+(1 row)
+</programlisting>
+ </refsection>
+
+ <refsection>
+ <title>See Also</title>
+
+ <para><xref linkend="ST_OrderingEquals"/>, <xref linkend="ST_Reverse"/></para>
+ </refsection>
+
+ </refentry>
+
<refentry id="ST_Intersects">
<refnamediv>
<refname>ST_Intersects</refname>
@@ -750,6 +813,78 @@
<para><xref linkend="ST_Disjoint"/>ST_Disjoint</para>
</refsection>
</refentry>
+ <refentry id="ST_OrderingEquals">
+ <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>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>boolean <function>ST_OrderingEquals</function></funcdef>
+ <paramdef><type>geometry </type> <parameter>A</parameter></paramdef>
+ <paramdef><type>geometry </type> <parameter>B</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+ <para>ST_OrderingEquals compares two geometries and t (TRUE) if the
+ geometries are equal and the coordinates are in the same order;
+ otherwise it returns f (FALSE).</para>
+
+ <note>
+ <para>This function is implemented as per the ArcSDE SQL
+ specification rather than SQL-MM.
+ http://edndoc.esri.com/arcsde/9.1/sql_api/sqlapi3.htm#ST_OrderingEquals</para>
+ </note>
+
+ <para>
+ <inlinegraphic class="sql_mm_compliant" fileref="images/check.png" />
+ This method implements the SQL/MM specification: SQL-MM 3: 5.1.43
+ </para>
+
+ </refsection>
+
+ <refsection>
+ <title>Examples</title>
+
+ <programlisting>SELECT ST_OrderingEquals(ST_GeomFromText('LINESTRING(0 0, 10 10)'),
+ ST_GeomFromText('LINESTRING(0 0, 5 5, 10 10)'));
+ st_orderingequals
+-----------
+ f
+(1 row)
+
+SELECT ST_OrderingEquals(ST_GeomFromText('LINESTRING(0 0, 10 10)'),
+ ST_GeomFromText('LINESTRING(0 0, 0 0, 10 10)'));
+ st_orderingequals
+-----------
+ t
+(1 row)
+
+SELECT ST_OrderingEquals(ST_Reverse(ST_GeomFromText('LINESTRING(0 0, 10 10)')),
+ ST_GeomFromText('LINESTRING(0 0, 0 0, 10 10)'));
+ st_orderingequals
+-----------
+ f
+(1 row)
+</programlisting>
+ </refsection>
+
+
+ <refsection>
+ <title>See Also</title>
+
+ <para><xref linkend="ST_Equals"/>, <xref linkend="ST_Reverse"/></para>
+ </refsection>
+
+ </refentry>
</sect1>
<sect1>
Modified: trunk/doc/template.xml
===================================================================
--- trunk/doc/template.xml 2008-07-15 18:02:06 UTC (rev 2856)
+++ trunk/doc/template.xml 2008-07-15 19:38:11 UTC (rev 2857)
@@ -11,15 +11,15 @@
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_MyMethod</function></funcdef>
- <paramdef><type>Geometry </type> <parameter>g1</parameter></paramdef>
- <paramdef><type>Geometry </type> <parameter>g2</parameter></paramdef>
+ <paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
+ <paramdef><type>geometry </type> <parameter>g2</parameter></paramdef>
</funcprototype>
<!-- an optional second method prototype -->
<funcprototype>
<funcdef>boolean <function>ST_MyMethod</function></funcdef>
- <paramdef><type>Geometry </type> <parameter>g1</parameter></paramdef>
- <paramdef><type>Geometry </type> <parameter>g2</parameter></paramdef>
+ <paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
+ <paramdef><type>geometry </type> <parameter>g2</parameter></paramdef>
<paramdef><type>varchar </type> <parameter>myparam</parameter></paramdef>
</funcprototype>
</funcsynopsis>
More information about the postgis-commits
mailing list