]> granicus.if.org Git - postgis/commitdiff
moved over &>| from reference.xml to reference_new.xml in the documentation
authorKevin Neufeld <kneufeld.ca@gmail.com>
Thu, 22 Jan 2009 00:44:07 +0000 (00:44 +0000)
committerKevin Neufeld <kneufeld.ca@gmail.com>
Thu, 22 Jan 2009 00:44:07 +0000 (00:44 +0000)
git-svn-id: http://svn.osgeo.org/postgis/trunk@3550 b70326c6-7e19-0410-871a-916f4a2858ee

doc/reference.xml
doc/reference_new.xml

index e6d2d0f065a4004ce7585a3e74a5d941e915a6cb..c9dad9e35a29b0378a9e9c5168d5113181da47c4 100644 (file)
           </listitem>
         </varlistentry>
 
-        <varlistentry>
-          <term>A &amp;&lt;| B</term>
-
-          <listitem>
-            <para>The "&amp;&lt;|" operator returns true if A's bounding box
-            overlaps or is below B's bounding box.</para>
-          </listitem>
-        </varlistentry>
-
         <varlistentry>
           <term>A |&amp;&gt; B</term>
 
index c9434bdd5387e221d6e85f647ed451bbbae77965..6097c38614114a27cff7da0e50c04793c0911ee0 100644 (file)
@@ -7700,7 +7700,7 @@ FROM ( VALUES
                  <refsection>
                    <title>See Also</title>
                
-                   <para><xref linkend="ST_Geometry_Overleft" />, <xref linkend="ST_Geometry_Overright" /></para>
+                   <para><xref linkend="ST_Geometry_Overleft" />, <xref linkend="ST_Geometry_Overright" />, <xref linkend="ST_Geometry_Overbelow" /></para>
                  </refsection>
                </refentry>
 
@@ -7716,7 +7716,7 @@ FROM ( VALUES
                      <funcprototype>
                        <!-- TODO: Ideally, it would be nice if this coule be reordered to 
                        "boolean (geometry A &< geometry B)" instead of 
-                       "boolean &&( geometry A, geometry B)" -->
+                       "boolean &<( geometry A, geometry B)" -->
                        <funcdef>boolean <function>&amp;&lt;</function></funcdef>
                
                        <paramdef>
@@ -7765,7 +7765,72 @@ FROM
                  <refsection>
                    <title>See Also</title>
                
-                   <para><xref linkend="ST_Geometry_Overlaps" />, <xref linkend="ST_Geometry_Overright" /></para>
+                   <para><xref linkend="ST_Geometry_Overlaps" />, <xref linkend="ST_Geometry_Overright" />, <xref linkend="ST_Geometry_Overbelow" /></para>
+                 </refsection>
+               </refentry>
+
+               <refentry id="ST_Geometry_Overbelow">   
+                 <refnamediv>
+                   <refname>&amp;&lt;|</refname>
+               
+                   <refpurpose>Returns <varname>TRUE</varname> if A overlaps or is below B.</refpurpose>
+                 </refnamediv>
+               
+                 <refsynopsisdiv>
+                   <funcsynopsis>
+                     <funcprototype>
+                       <!-- TODO: Ideally, it would be nice if this coule be reordered to 
+                       "boolean (geometry A &<| geometry B)" instead of 
+                       "boolean &<|( geometry A, geometry B)" -->
+                       <funcdef>boolean <function>&amp;&lt;|</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>The <varname>&amp;&lt;|</varname> operator returns <varname>TRUE</varname> if the bounding box of geometry A
+            overlaps or is below of the bounding box of geometry B, or more accurately, overlaps or is NOT above the bounding 
+            box of geometry B.</para>
+                 </refsection>
+               
+                 <refsection>
+                   <title>Examples</title>
+               
+                   <programlisting>SELECT tbl1.column1, tbl2.column1, tbl1.column2 &amp;&lt;| tbl2.column2 AS overlaps
+FROM 
+  ( VALUES
+       (1, 'LINESTRING(6 0, 6 4)'::geometry)) AS tbl1,
+  ( VALUES
+       (2, 'LINESTRING(0 0, 3 3)'::geometry), 
+       (3, 'LINESTRING(0 1, 0 5)'::geometry), 
+       (4, 'LINESTRING(1 2, 4 6)'::geometry)) AS tbl2;
+
+ column1 | column1 | overlaps 
+---------+---------+----------
+       1 |       2 | f
+       1 |       3 | t
+       1 |       4 | t
+(3 rows)</programlisting>
+                 </refsection>
+               
+                 <refsection>
+                   <title>See Also</title>
+               
+                   <para><xref linkend="ST_Geometry_Overlaps" />, <xref linkend="ST_Geometry_Overleft" />, <xref linkend="ST_Geometry_Overright" /></para>
                  </refsection>
                </refentry>
 
@@ -7781,7 +7846,7 @@ FROM
                      <funcprototype>
                        <!-- TODO: Ideally, it would be nice if this coule be reordered to 
                        "boolean (geometry A &> geometry B)" instead of 
-                       "boolean &&( geometry A, geometry B)" -->
+                       "boolean &>( geometry A, geometry B)" -->
                        <funcdef>boolean <function>&amp;&gt;</function></funcdef>
                
                        <paramdef>
@@ -7830,7 +7895,7 @@ FROM
                  <refsection>
                    <title>See Also</title>
                
-                   <para><xref linkend="ST_Geometry_Overlaps" />, <xref linkend="ST_Geometry_Overleft" /></para>
+                   <para><xref linkend="ST_Geometry_Overlaps" />, <xref linkend="ST_Geometry_Overleft" />, <xref linkend="ST_Geometry_Overbelow" /></para>
                  </refsection>
                </refentry>