1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337
|
<!-- Converted by db4-upgrade version 1.1 -->
<section xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Spatial_Relationships">
<title>Spatial Relationships</title><info>
<abstract>
<para>These functions determine spatial relationships between geometries.</para>
</abstract>
</info>
<section>
<title>Topological Relationships</title>
<refentry xml:id="ST_3DIntersects">
<refnamediv>
<refname>ST_3DIntersects</refname>
<refpurpose>Tests if two geometries spatially
intersect in 3D - only for points, linestrings, polygons, polyhedral surface (area)
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_3DIntersects</function></funcdef>
<paramdef>
<type>geometry</type>
<parameter>geomA</parameter>
</paramdef>
<paramdef>
<type>geometry</type>
<parameter>geomB</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Overlaps, Touches, Within all imply spatial intersection. If any of the aforementioned
returns true, then the geometries also spatially intersect.
Disjoint implies false for spatial intersection.</para>
<note><para>&index_aware;</para></note>
<note><para>Because of floating robustness failures, geometries don't always intersect as you'd expect them to after geometric processing. For example the closest point on a linestring to a geometry may not lie on the linestring. For these kind of issues where a distance of a centimeter you want to just consider as intersecting, use <xref linkend="ST_3DDWithin"/>.</para></note>
<para role="changed" conformance="3.0.0">Changed: 3.0.0 SFCGAL backend removed, GEOS backend supports TINs.</para>
<para role="availability" conformance="2.0.0">Availability: 2.0.0</para>
<para>&Z_support;</para>
<!-- Optionally mention supports Polyhedral Surface -->
<para>&P_support;</para>
<para>&T_support;</para>
<para>&sqlmm_compliant; SQL-MM IEC 13249-3: 5.1</para>
</refsection>
<refsection>
<title>Geometry Examples</title>
<programlisting>SELECT ST_3DIntersects(pt, line), ST_Intersects(pt, line)
FROM (SELECT 'POINT(0 0 2)'::geometry As pt, 'LINESTRING (0 0 1, 0 2 3)'::geometry As line) As foo;
st_3dintersects | st_intersects
-----------------+---------------
f | t
(1 row)
</programlisting>
</refsection>
<refsection><title>TIN Examples</title>
<programlisting>SELECT ST_3DIntersects('TIN(((0 0 0,1 0 0,0 1 0,0 0 0)))'::geometry, 'POINT(.1 .1 0)'::geometry);
st_3dintersects
-----------------
t</programlisting></refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_3DDWithin"/>, <xref linkend="ST_Intersects"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Contains">
<refnamediv>
<refname>ST_Contains</refname>
<refpurpose>Tests if every point of B lies in A, and their interiors have a point in common</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_Contains</function></funcdef>
<paramdef><type>geometry </type>
<parameter>geomA</parameter></paramdef>
<paramdef><type>geometry </type>
<parameter>geomB</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns TRUE if geometry A contains geometry B.
A contains B if and only if all points of B lie inside (i.e. in the interior or boundary of) A
(or equivalently, no points of B lie in the exterior of A),
and the interiors of A and B have at least one point in common.
</para>
<para>In mathematical terms:
<emphasis>ST_Contains(A, B) ⇔ (A ⋂ B = B) ∧ (Int(A) ⋂ Int(B) ≠ ∅) </emphasis></para>
<para>The contains relationship is reflexive: every geometry contains itself.
(In contrast, in the <xref linkend="ST_ContainsProperly"/>
predicate a geometry does <emphasis>not</emphasis> properly contain itself.)
The relationship is antisymmetric: if <code>ST_Contains(A,B) = true</code> and <code>ST_Contains(B,A) = true</code>, then
the two geometries must be topologically equal (<code>ST_Equals(A,B) = true</code>).
</para>
<para>ST_Contains is the converse of <xref linkend="ST_Within"/>.
So, <code>ST_Contains(A,B) = ST_Within(B,A)</code>.</para>
<note><para>Because the interiors must have a common point, a subtlety of the definition is that
polygons and lines do <emphasis>not</emphasis> contain lines and points lying fully in their boundary.
For further details see <link xlink:href="http://lin-ear-th-inking.blogspot.com/2007/06/subtleties-of-ogc-covers-spatial.html">Subtleties of OGC Covers, Contains, Within</link>.
The <xref linkend="ST_Covers"/> predicate provides a more inclusive relationship.
</para></note>
<note><para>&index_aware;
To avoid index use, use the function <function>_ST_Contains</function>.</para></note>
<para>Performed by the GEOS module</para>
<para role="enhanced" conformance="2.3.0">Enhanced: 2.3.0 Enhancement to PIP short-circuit extended to support MultiPoints with few points. Prior versions only supported point in polygon.</para>
<important>
<para role="enhanced" conformance="3.0.0">Enhanced: 3.0.0 enabled support for <varname>GEOMETRYCOLLECTION</varname></para>
</important>
<important>
<para>Do not use this function with invalid geometries. You will get unexpected results.</para>
</important>
<para>NOTE: this is the "allowable" version that returns a
boolean, not an integer.</para>
<para>&sfs_compliant; s2.1.1.2 // s2.1.13.3
- same as within(geometry B, geometry A)</para>
<para>&sqlmm_compliant; SQL-MM 3: 5.1.31</para>
</refsection>
<refsection>
<title>Examples</title>
<para><function>ST_Contains</function> returns <varname>TRUE</varname> in the following situations:</para>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_contains01.png"/>
</imageobject>
<caption><para><varname>LINESTRING</varname> / <varname>MULTIPOINT</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_contains02.png"/>
</imageobject>
<caption><para><varname>POLYGON</varname> / <varname>POINT</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
</row>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_contains03.png"/>
</imageobject>
<caption><para><varname>POLYGON</varname> / <varname>LINESTRING</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_contains04.png"/>
</imageobject>
<caption><para><varname>POLYGON</varname> / <varname>POLYGON</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para><function>ST_Contains</function> returns <varname>FALSE</varname> in the following situations:</para>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_contains05.png"/>
</imageobject>
<caption><para><varname>POLYGON</varname> / <varname>MULTIPOINT</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_contains06.png"/>
</imageobject>
<caption><para><varname>POLYGON</varname> / <varname>LINESTRING</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>Due to the interior intersection condition <function>ST_Contains</function> returns <varname>FALSE</varname> in the following situations
(whereas <function>ST_Covers</function> returns <varname>TRUE</varname>):</para>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_contains07.png"/>
</imageobject>
<caption><para><varname>LINESTRING</varname> / <varname>POINT</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_contains08.png"/>
</imageobject>
<caption><para><varname>POLYGON</varname> / <varname>LINESTRING</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<programlisting>
-- A circle within a circle
SELECT ST_Contains(smallc, bigc) As smallcontainsbig,
ST_Contains(bigc,smallc) As bigcontainssmall,
ST_Contains(bigc, ST_Union(smallc, bigc)) as bigcontainsunion,
ST_Equals(bigc, ST_Union(smallc, bigc)) as bigisunion,
ST_Covers(bigc, ST_ExteriorRing(bigc)) As bigcoversexterior,
ST_Contains(bigc, ST_ExteriorRing(bigc)) As bigcontainsexterior
FROM (SELECT ST_Buffer(ST_GeomFromText('POINT(1 2)'), 10) As smallc,
ST_Buffer(ST_GeomFromText('POINT(1 2)'), 20) As bigc) As foo;
-- Result
smallcontainsbig | bigcontainssmall | bigcontainsunion | bigisunion | bigcoversexterior | bigcontainsexterior
------------------+------------------+------------------+------------+-------------------+---------------------
f | t | t | t | t | f
-- Example demonstrating difference between contains and contains properly
SELECT ST_GeometryType(geomA) As geomtype, ST_Contains(geomA,geomA) AS acontainsa, ST_ContainsProperly(geomA, geomA) AS acontainspropa,
ST_Contains(geomA, ST_Boundary(geomA)) As acontainsba, ST_ContainsProperly(geomA, ST_Boundary(geomA)) As acontainspropba
FROM (VALUES ( ST_Buffer(ST_Point(1,1), 5,1) ),
( ST_MakeLine(ST_Point(1,1), ST_Point(-1,-1) ) ),
( ST_Point(1,1) )
) As foo(geomA);
geomtype | acontainsa | acontainspropa | acontainsba | acontainspropba
--------------+------------+----------------+-------------+-----------------
ST_Polygon | t | f | f | f
ST_LineString | t | f | f | f
ST_Point | t | t | f | f
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Boundary"/>, <xref linkend="ST_ContainsProperly"/>, <xref linkend="ST_Covers"/>, <xref linkend="ST_CoveredBy"/>, <xref linkend="ST_Equals"/>, <xref linkend="ST_Within"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_ContainsProperly">
<refnamediv>
<refname>ST_ContainsProperly</refname>
<refpurpose>Tests if every point of B lies in the interior of A</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_ContainsProperly</function></funcdef>
<paramdef><type>geometry </type>
<parameter>geomA</parameter></paramdef>
<paramdef><type>geometry </type>
<parameter>geomB</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns <varname>true</varname> if every point of B lies in the interior of A
(or equivalently, no point of B lies in the the boundary or exterior of A).</para>
<para>In mathematical terms:
<emphasis>ST_ContainsProperly(A, B) ⇔ Int(A) ⋂ B = B </emphasis></para>
<para>A contains B properly if the DE-9IM Intersection Matrix for the two geometries matches
[T**FF*FF*]</para>
<para>A does not properly contain itself, but does contain itself.</para>
<para>
A use for this predicate is computing the intersections of a set of geometries with a large polygonal geometry. Since intersection is a fairly slow operation, it can be more efficient to use containsProperly to filter out test geometries which lie
fully inside the area. In these cases the intersection is known a priori to be exactly the original test geometry.
</para>
<note><para>&index_aware;
To avoid index use, use the function <function>_ST_ContainsProperly</function>.</para></note>
<note>
<para>The advantage of this predicate over <xref linkend="ST_Contains"/> and <xref linkend="ST_Intersects"/> is that it can be computed
more efficiently, with no need to compute topology at individual points.</para>
</note>
<para>Performed by the GEOS module.</para>
<para role="availability" conformance="1.4.0">Availability: 1.4.0</para>
<important>
<para role="enhanced" conformance="3.0.0">Enhanced: 3.0.0 enabled support for <varname>GEOMETRYCOLLECTION</varname></para>
</important>
<important>
<para>Do not use this function with invalid geometries. You will get unexpected results.</para>
</important>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
--a circle within a circle
SELECT ST_ContainsProperly(smallc, bigc) As smallcontainspropbig,
ST_ContainsProperly(bigc,smallc) As bigcontainspropsmall,
ST_ContainsProperly(bigc, ST_Union(smallc, bigc)) as bigcontainspropunion,
ST_Equals(bigc, ST_Union(smallc, bigc)) as bigisunion,
ST_Covers(bigc, ST_ExteriorRing(bigc)) As bigcoversexterior,
ST_ContainsProperly(bigc, ST_ExteriorRing(bigc)) As bigcontainsexterior
FROM (SELECT ST_Buffer(ST_GeomFromText('POINT(1 2)'), 10) As smallc,
ST_Buffer(ST_GeomFromText('POINT(1 2)'), 20) As bigc) As foo;
--Result
smallcontainspropbig | bigcontainspropsmall | bigcontainspropunion | bigisunion | bigcoversexterior | bigcontainsexterior
------------------+------------------+------------------+------------+-------------------+---------------------
f | t | f | t | t | f
--example demonstrating difference between contains and contains properly
SELECT ST_GeometryType(geomA) As geomtype, ST_Contains(geomA,geomA) AS acontainsa, ST_ContainsProperly(geomA, geomA) AS acontainspropa,
ST_Contains(geomA, ST_Boundary(geomA)) As acontainsba, ST_ContainsProperly(geomA, ST_Boundary(geomA)) As acontainspropba
FROM (VALUES ( ST_Buffer(ST_Point(1,1), 5,1) ),
( ST_MakeLine(ST_Point(1,1), ST_Point(-1,-1) ) ),
( ST_Point(1,1) )
) As foo(geomA);
geomtype | acontainsa | acontainspropa | acontainsba | acontainspropba
--------------+------------+----------------+-------------+-----------------
ST_Polygon | t | f | f | f
ST_LineString | t | f | f | f
ST_Point | t | t | f | f
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_GeometryType"/>, <xref linkend="ST_Boundary"/>, <xref linkend="ST_Contains"/>, <xref linkend="ST_Covers"/>, <xref linkend="ST_CoveredBy"/>, <xref linkend="ST_Equals"/>, <xref linkend="ST_Relate"/>, <xref linkend="ST_Within"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_CoveredBy">
<refnamediv>
<refname>ST_CoveredBy</refname>
<refpurpose>Tests if every point of A lies in B</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_CoveredBy</function></funcdef>
<paramdef><type>geometry </type>
<parameter>geomA</parameter></paramdef>
<paramdef><type>geometry </type>
<parameter>geomB</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>boolean <function>ST_CoveredBy</function></funcdef>
<paramdef><type>geography </type>
<parameter>geogA</parameter></paramdef>
<paramdef><type>geography </type>
<parameter>geogB</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns <varname>true</varname> if every point in Geometry/Geography A lies inside
(i.e. intersects the interior or boundary of)
Geometry/Geography B.
Equivalently, tests that no point of A lies outside (in the exterior of) B.
</para>
<para>In mathematical terms:
<emphasis>ST_CoveredBy(A, B) ⇔ A ⋂ B = A </emphasis></para>
<para>ST_CoveredBy is the converse of <xref linkend="ST_Covers"/>.
So, <code>ST_CoveredBy(A,B) = ST_Covers(B,A)</code>.</para>
<para>Generally this function should be used instead of <xref linkend="ST_Within"/>,
since it has a simpler definition
which does not have the quirk that "boundaries are not within their geometry".</para>
<note><para>&index_aware;
To avoid index use, use the function <function>_ST_CoveredBy</function>.</para></note>
<important>
<para role="enhanced" conformance="3.0.0">Enhanced: 3.0.0 enabled support for <varname>GEOMETRYCOLLECTION</varname></para>
</important>
<important>
<para>Do not use this function with invalid geometries. You will get unexpected results.</para>
</important>
<para>Performed by the GEOS module</para>
<para role="availability" conformance="1.2.2">Availability: 1.2.2</para>
<para>NOTE: this is the "allowable" version that returns a
boolean, not an integer.</para>
<para>Not an OGC standard, but Oracle has it too.</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
--a circle coveredby a circle
SELECT ST_CoveredBy(smallc,smallc) As smallinsmall,
ST_CoveredBy(smallc, bigc) As smallcoveredbybig,
ST_CoveredBy(ST_ExteriorRing(bigc), bigc) As exteriorcoveredbybig,
ST_Within(ST_ExteriorRing(bigc),bigc) As exeriorwithinbig
FROM (SELECT ST_Buffer(ST_GeomFromText('POINT(1 2)'), 10) As smallc,
ST_Buffer(ST_GeomFromText('POINT(1 2)'), 20) As bigc) As foo;
--Result
smallinsmall | smallcoveredbybig | exteriorcoveredbybig | exeriorwithinbig
--------------+-------------------+----------------------+------------------
t | t | t | f
(1 row) </programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Contains"/>, <xref linkend="ST_Covers"/>, <xref linkend="ST_ExteriorRing"/>, <xref linkend="ST_Within"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Covers">
<refnamediv>
<refname>ST_Covers</refname>
<refpurpose>Tests if every point of B lies in A</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_Covers</function></funcdef>
<paramdef><type>geometry </type>
<parameter>geomA</parameter></paramdef>
<paramdef><type>geometry </type>
<parameter>geomB</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>boolean <function>ST_Covers</function></funcdef>
<paramdef><type>geography </type>
<parameter>geogpolyA</parameter></paramdef>
<paramdef><type>geography </type>
<parameter>geogpointB</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns <varname>true</varname> if every point in Geometry/Geography B lies inside
(i.e. intersects the interior or boundary of)
Geometry/Geography A.
Equivalently, tests that no point of B lies outside (in the exterior of) A.
</para>
<para>In mathematical terms:
<emphasis>ST_Covers(A, B) ⇔ A ⋂ B = B </emphasis></para>
<para>ST_Covers is the converse of <xref linkend="ST_CoveredBy"/>.
So, <code>ST_Covers(A,B) = ST_CoveredBy(B,A)</code>.</para>
<para>Generally this function should be used instead of <xref linkend="ST_Contains"/>,
since it has a simpler definition
which does not have the quirk that "geometries do not contain their boundary".</para>
<note><para>&index_aware;
To avoid index use, use the function <function>_ST_Covers</function>.</para></note>
<important>
<para role="enhanced" conformance="3.0.0">Enhanced: 3.0.0 enabled support for <varname>GEOMETRYCOLLECTION</varname></para>
</important>
<important>
<para>Do not use this function with invalid geometries. You will get unexpected results.</para>
</important>
<para>Performed by the GEOS module</para>
<para role="enhanced" conformance="2.4.0">Enhanced: 2.4.0 Support for polygon in polygon and line in polygon added for geography type</para>
<para role="enhanced" conformance="2.3.0">Enhanced: 2.3.0 Enhancement to PIP short-circuit for geometry extended to support MultiPoints with few points. Prior versions only supported point in polygon.</para>
<para role="availability" conformance="1.5">Availability: 1.5 - support for geography was introduced. </para>
<para role="availability" conformance="1.2.2">Availability: 1.2.2</para>
<para>NOTE: this is the "allowable" version that returns a
boolean, not an integer.</para>
<para>Not an OGC standard, but Oracle has it too.</para>
</refsection>
<refsection>
<title>Examples</title>
<para> Geometry example </para>
<programlisting>
--a circle covering a circle
SELECT ST_Covers(smallc,smallc) As smallinsmall,
ST_Covers(smallc, bigc) As smallcoversbig,
ST_Covers(bigc, ST_ExteriorRing(bigc)) As bigcoversexterior,
ST_Contains(bigc, ST_ExteriorRing(bigc)) As bigcontainsexterior
FROM (SELECT ST_Buffer(ST_GeomFromText('POINT(1 2)'), 10) As smallc,
ST_Buffer(ST_GeomFromText('POINT(1 2)'), 20) As bigc) As foo;
--Result
smallinsmall | smallcoversbig | bigcoversexterior | bigcontainsexterior
--------------+----------------+-------------------+---------------------
t | f | t | f
(1 row) </programlisting>
<para>Geeography Example</para>
<programlisting>
-- a point with a 300 meter buffer compared to a point, a point and its 10 meter buffer
SELECT ST_Covers(geog_poly, geog_pt) As poly_covers_pt,
ST_Covers(ST_Buffer(geog_pt,10), geog_pt) As buff_10m_covers_cent
FROM (SELECT ST_Buffer(ST_GeogFromText('SRID=4326;POINT(-99.327 31.4821)'), 300) As geog_poly,
ST_GeogFromText('SRID=4326;POINT(-99.33 31.483)') As geog_pt ) As foo;
poly_covers_pt | buff_10m_covers_cent
----------------+------------------
f | t
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Contains"/>, <xref linkend="ST_CoveredBy"/>, <xref linkend="ST_Within"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Crosses">
<refnamediv>
<refname>ST_Crosses</refname>
<refpurpose>Tests if two geometries have some, but not all, interior points in common</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_Crosses</function></funcdef>
<paramdef><type>geometry </type><parameter>g1</parameter></paramdef>
<paramdef><type>geometry </type><parameter>g2</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Compares two geometry objects and
returns <varname>true</varname> if their intersection "spatially crosses";
that is, the geometries have some, but not all interior points in common.
The intersection of the interiors of the geometries must be non-empty
and must have dimension less than the maximum dimension
of the two input geometries, and the intersection of the two
geometries must not equal either geometry. Otherwise, it
returns <varname>false</varname>.
The crosses relation is symmetric and irreflexive.</para>
<para>In mathematical terms:
<emphasis>ST_Crosses(A, B) ⇔ (dim( Int(A) ⋂ Int(B) ) < max( dim( Int(A) ), dim( Int(B) ) )) ∧ (A ⋂ B ≠ A) ∧ (A ⋂ B ≠ B) </emphasis></para>
<para>Geometries cross if their DE-9IM Intersection Matrix matches:</para>
<itemizedlist>
<listitem>
<para><code>T*T******</code> for Point/Line, Point/Area, and Line/Area situations</para>
</listitem>
<listitem>
<para><code>T*****T**</code> for Line/Point, Area/Point, and Area/Line situations</para>
</listitem>
<listitem>
<para><code>0********</code> for Line/Line situations</para>
</listitem>
<listitem>
<para>the result is <varname>false</varname> for Point/Point and Area/Area situations </para>
</listitem>
</itemizedlist>
<note><para>The OpenGIS Simple Features Specification defines this predicate
only for Point/Line, Point/Area, Line/Line, and Line/Area situations.
JTS / GEOS extends the definition to apply to Line/Point, Area/Point and
Area/Line situations as well. This makes the relation symmetric.</para></note>
<note><para>&index_aware;</para></note>
<important>
<para role="enhanced" conformance="3.0.0">Enhanced: 3.0.0 enabled support for <varname>GEOMETRYCOLLECTION</varname></para>
</important>
<para>&sfs_compliant; s2.1.13.3</para>
<para>&sqlmm_compliant; SQL-MM 3: 5.1.29</para>
</refsection>
<refsection>
<title>Examples</title>
<para>The following situations all return <varname>true</varname>.</para>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_crosses01.png"/>
</imageobject>
<caption><para><varname>MULTIPOINT</varname> / <varname>LINESTRING</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_crosses02.png"/>
</imageobject>
<caption><para><varname>MULTIPOINT</varname> / <varname>POLYGON</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
</row>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_crosses03.png"/>
</imageobject>
<caption><para><varname>LINESTRING</varname> / <varname>POLYGON</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_crosses04.png"/>
</imageobject>
<caption><para><varname>LINESTRING</varname> / <varname>LINESTRING</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>Consider a situation where a user has two tables: a table of roads
and a table of highways.</para>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry><para> <informalexample>
<programlisting>CREATE TABLE roads (
id serial NOT NULL,
geom geometry,
CONSTRAINT roads_pkey PRIMARY KEY (road_id)
);</programlisting>
</informalexample> </para></entry>
<entry><para> <informalexample>
<programlisting>CREATE TABLE highways (
id serial NOT NULL,
the_gem geometry,
CONSTRAINT roads_pkey PRIMARY KEY (road_id)
);</programlisting>
</informalexample> </para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>To determine a list of roads that cross a highway, use a query
similar to:</para>
<para><informalexample>
<programlisting>SELECT roads.id
FROM roads, highways
WHERE ST_Crosses(roads.geom, highways.geom);</programlisting>
</informalexample></para>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Contains"/>, <xref linkend="ST_Overlaps"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Disjoint">
<refnamediv>
<refname>ST_Disjoint</refname>
<refpurpose>Tests if two geometries have no points in common </refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_Disjoint</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 <varname>true</varname> if two geometries are disjoint.
Geometries are disjoint if they have no point in common.
</para>
<para>If any other spatial relationship is true for a pair of geometries, they are not disjoint.
Disjoint implies that <xref linkend="ST_Intersects"/> is false.
</para>
<para>In mathematical terms:
<emphasis>ST_Disjoint(A, B) ⇔ A ⋂ B = ∅ </emphasis></para>
<important>
<para role="enhanced" conformance="3.0.0">Enhanced: 3.0.0 enabled support for <varname>GEOMETRYCOLLECTION</varname></para>
</important>
<para>Performed by the GEOS module</para>
<note>
<para>This function call does not use indexes. A negated <xref linkend="ST_Intersects"/> predicate
can be used as a more performant alternative that uses indexes:
<code>ST_Disjoint(A,B) = NOT ST_Intersects(A,B)</code></para>
</note>
<note>
<para>NOTE: this is the "allowable" version that returns a
boolean, not an integer.</para>
</note>
<para>&sfs_compliant; s2.1.1.2 //s2.1.13.3
- a.Relate(b, 'FF*FF****')</para>
<para>&sqlmm_compliant; SQL-MM 3: 5.1.26</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_Disjoint('POINT(0 0)'::geometry, 'LINESTRING ( 2 0, 0 2 )'::geometry);
st_disjoint
---------------
t
(1 row)
SELECT ST_Disjoint('POINT(0 0)'::geometry, 'LINESTRING ( 0 0, 0 2 )'::geometry);
st_disjoint
---------------
f
(1 row)
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Intersects"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Equals">
<refnamediv>
<refname>ST_Equals</refname>
<refpurpose>Tests if two geometries include the same set of points</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 <varname>true</varname> if the given geometries are "topologically equal".
Use this for a 'better' answer than '='.
Topological equality means that the geometries have the same dimension,
and their point-sets occupy the same space.
This means that the order of vertices may be different in topologically equal geometries.
To verify the order of points is consistent use
<xref linkend="ST_OrderingEquals"/> (it must be noted ST_OrderingEquals is a little more stringent than simply verifying order of
points are the same).</para>
<para>In mathematical terms:
<emphasis>ST_Equals(A, B) ⇔ A = B </emphasis></para>
<para>The following relation holds:
<emphasis>ST_Equals(A, B) ⇔ ST_Within(A,B) ∧ ST_Within(B,A) </emphasis></para>
<important>
<para role="enhanced" conformance="3.0.0">Enhanced: 3.0.0 enabled support for <varname>GEOMETRYCOLLECTION</varname></para>
</important>
<para>&sfs_compliant; s2.1.1.2</para>
<para>&sqlmm_compliant; SQL-MM 3: 5.1.24</para>
<para role="changed" conformance="2.2.0">Changed: 2.2.0 Returns true even for invalid geometries if they are binary equal</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_IsValid"/>, <xref linkend="ST_OrderingEquals"/>, <xref linkend="ST_Reverse"/>, <xref linkend="ST_Within"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Intersects">
<refnamediv>
<refname>ST_Intersects</refname>
<refpurpose>Tests if two geometries intersect (they have at least one point in common)</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_Intersects</function></funcdef>
<paramdef>
<type>geometry</type>
<parameter>geomA</parameter>
</paramdef>
<paramdef>
<type>geometry</type>
<parameter>geomB</parameter>
</paramdef>
</funcprototype>
<funcprototype>
<funcdef>boolean <function>ST_Intersects</function></funcdef>
<paramdef>
<type>geography</type>
<parameter>geogA</parameter>
</paramdef>
<paramdef>
<type>geography</type>
<parameter>geogB</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns <varname>true</varname> if two geometries intersect.
Geometries intersect if they have any point in common.
</para>
<para>
For geography, a distance tolerance of 0.00001 meters is used
(so points that are very close are considered to intersect).</para>
<para>In mathematical terms:
<emphasis>ST_Intersects(A, B) ⇔ A ⋂ B ≠ ∅ </emphasis></para>
<para>Geometries intersect if their DE-9IM Intersection Matrix matches one of:
</para>
<itemizedlist>
<listitem> <para><code>T********</code></para> </listitem>
<listitem> <para><code>*T*******</code></para> </listitem>
<listitem> <para><code>***T*****</code></para> </listitem>
<listitem> <para><code>****T****</code></para> </listitem>
</itemizedlist>
<para>Spatial intersection is implied by all the other spatial relationship tests,
except <xref linkend="ST_Disjoint"/>, which tests that geometries do NOT intersect.</para>
<note><para>&index_aware;</para></note>
<para role="changed" conformance="3.0.0">Changed: 3.0.0 SFCGAL version removed and native support for 2D TINS added.</para>
<para role="enhanced" conformance="2.5.0">Enhanced: 2.5.0 Supports GEOMETRYCOLLECTION.</para>
<para role="enhanced" conformance="2.3.0">Enhanced: 2.3.0 Enhancement to PIP short-circuit extended to support MultiPoints with few points. Prior versions only supported point in polygon.</para>
<para>Performed by the GEOS module (for geometry), geography is native</para>
<para role="availability" conformance="1.5">Availability: 1.5 support for geography was introduced.</para>
<note>
<para>For geography, this function has a distance tolerance of about 0.00001 meters and uses the sphere rather
than spheroid calculation.</para>
</note>
<note>
<para>NOTE: this is the "allowable" version that returns a
boolean, not an integer.</para>
</note>
<para>&sfs_compliant; s2.1.1.2 //s2.1.13.3
- ST_Intersects(g1, g2 ) --> Not (ST_Disjoint(g1, g2 ))
</para>
<para>&sqlmm_compliant; SQL-MM 3: 5.1.27</para>
<para>&curve_support;</para>
<!-- Optionally mention support for Triangles and TINS -->
<para>&T_support;</para>
</refsection>
<refsection>
<title>Geometry Examples</title>
<programlisting>SELECT ST_Intersects('POINT(0 0)'::geometry, 'LINESTRING ( 2 0, 0 2 )'::geometry);
st_intersects
---------------
f
(1 row)
SELECT ST_Intersects('POINT(0 0)'::geometry, 'LINESTRING ( 0 0, 0 2 )'::geometry);
st_intersects
---------------
t
(1 row)
-- Look up in table. Make sure table has a GiST index on geometry column for faster lookup.
SELECT id, name FROM cities WHERE ST_Intersects(geom, 'SRID=4326;POLYGON((28 53,27.707 52.293,27 52,26.293 52.293,26 53,26.293 53.707,27 54,27.707 53.707,28 53))');
id | name
----+-------
2 | Minsk
(1 row)
</programlisting>
</refsection>
<refsection>
<title>Geography Examples</title>
<programlisting>SELECT ST_Intersects(
'SRID=4326;LINESTRING(-43.23456 72.4567,-43.23456 72.4568)'::geography,
'SRID=4326;POINT(-43.23456 72.4567772)'::geography
);
st_intersects
---------------
t
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="geometry_overlaps"/>, <xref linkend="ST_3DIntersects"/>, <xref linkend="ST_Disjoint"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_LineCrossingDirection">
<refnamediv>
<refname>ST_LineCrossingDirection</refname>
<refpurpose>Returns a number indicating the crossing behavior of two LineStrings</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>integer <function>ST_LineCrossingDirection</function></funcdef>
<paramdef><type>geometry </type> <parameter>linestringA</parameter></paramdef>
<paramdef><type>geometry </type> <parameter>linestringB</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Given two linestrings returns an integer between -3 and 3
indicating what kind of crossing behavior exists between them.
0 indicates no crossing.
This is only supported for <varname>LINESTRING</varname>s.
</para>
<para>The crossing number has the following meaning:
<itemizedlist>
<listitem>
<para> 0: LINE NO CROSS</para>
</listitem>
<listitem>
<para>-1: LINE CROSS LEFT</para>
</listitem>
<listitem>
<para> 1: LINE CROSS RIGHT</para>
</listitem>
<listitem>
<para>-2: LINE MULTICROSS END LEFT</para>
</listitem>
<listitem>
<para> 2: LINE MULTICROSS END RIGHT</para>
</listitem>
<listitem>
<para>-3: LINE MULTICROSS END SAME FIRST LEFT</para>
</listitem>
<listitem>
<para> 3: LINE MULTICROSS END SAME FIRST RIGHT</para>
</listitem>
</itemizedlist>
</para>
<para role="availability" conformance="1.4">Availability: 1.4</para>
</refsection>
<refsection>
<title>Examples</title>
<para><emphasis role="bold">Example:</emphasis>
LINE CROSS LEFT and LINE CROSS RIGHT
</para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_linecrossingdirection03.png"/>
</imageobject>
<caption><para>Blue: Line A; Green: Line B</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_LineCrossingDirection(lineA, lineB) As A_cross_B,
ST_LineCrossingDirection(lineB, lineA) As B_cross_A
FROM (SELECT
ST_GeomFromText('LINESTRING(25 169,89 114,40 70,86 43)') As lineA,
ST_GeomFromText('LINESTRING (20 140, 71 74, 161 53)') As lineB
) As foo;
A_cross_B | B_cross_A
-----------+-----------
-1 | 1
</programlisting>
<para><emphasis role="bold">Example:</emphasis>
LINE MULTICROSS END SAME FIRST LEFT and LINE MULTICROSS END SAME FIRST RIGHT
</para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_linecrossingdirection01.png"/>
</imageobject>
<caption><para>Blue: Line A; Green: Line B</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_LineCrossingDirection(lineA, lineB) As A_cross_B,
ST_LineCrossingDirection(lineB, lineA) As B_cross_A
FROM (SELECT
ST_GeomFromText('LINESTRING(25 169,89 114,40 70,86 43)') As lineA,
ST_GeomFromText('LINESTRING(171 154,20 140,71 74,161 53)') As lineB
) As foo;
A_cross_B | B_cross_A
-----------+-----------
3 | -3
</programlisting>
<para><emphasis role="bold">Example:</emphasis>
LINE MULTICROSS END LEFT and LINE MULTICROSS END RIGHT
</para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_linecrossingdirection04.png"/>
</imageobject>
<caption><para>Blue: Line A; Green: Line B</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_LineCrossingDirection(lineA, lineB) As A_cross_B,
ST_LineCrossingDirection(lineB, lineA) As B_cross_A
FROM (SELECT
ST_GeomFromText('LINESTRING(25 169,89 114,40 70,86 43)') As lineA,
ST_GeomFromText('LINESTRING(5 90, 71 74, 20 140, 171 154)') As lineB
) As foo;
A_cross_B | B_cross_A
-----------+-----------
-2 | 2
</programlisting>
<para><emphasis role="bold">Example:</emphasis>
Finds all streets that cross
</para>
<programlisting><![CDATA[
SELECT s1.gid, s2.gid, ST_LineCrossingDirection(s1.geom, s2.geom)
FROM streets s1 CROSS JOIN streets s2
ON (s1.gid != s2.gid AND s1.geom && s2.geom )
WHERE ST_LineCrossingDirection(s1.geom, s2.geom) > 0;
]]></programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Crosses"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_OrderingEquals">
<refnamediv>
<refname>ST_OrderingEquals</refname>
<refpurpose>Tests if two geometries represent the same geometry and have points 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 returns 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>&sqlmm_compliant; 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="geometry_overlaps"/>, <xref linkend="ST_Equals"/>, <xref linkend="ST_Reverse"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Overlaps">
<refnamediv>
<refname>ST_Overlaps</refname>
<refpurpose>Tests if two geometries have the same dimension and intersect, but each has at least one point not in the other</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_Overlaps</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 geometry A and B "spatially overlap".
Two geometries overlap if they have the same dimension,
their interiors intersect in that dimension.
and each has at least one point inside the other
(or equivalently, neither one covers the other).
The overlaps relation is symmetric and irreflexive.
</para>
<para>In mathematical terms:
<emphasis>ST_Overlaps(A, B) ⇔ ( dim(A) = dim(B) = dim( Int(A) ⋂ Int(B) )) ∧ (A ⋂ B ≠ A) ∧ (A ⋂ B ≠ B) </emphasis></para>
<note><para>&index_aware;
To avoid index use, use the function <function>_ST_Overlaps</function>.</para></note>
<para>Performed by the GEOS module</para>
<important>
<para role="enhanced" conformance="3.0.0">Enhanced: 3.0.0 enabled support for <varname>GEOMETRYCOLLECTION</varname></para>
</important>
<para>NOTE: this is the "allowable" version that returns a
boolean, not an integer.</para>
<para>&sfs_compliant; s2.1.1.2 // s2.1.13.3</para>
<para>&sqlmm_compliant; SQL-MM 3: 5.1.32</para>
</refsection>
<refsection>
<title>Examples</title>
<para><function>ST_Overlaps</function> returns <varname>TRUE</varname> in the following situations:</para>
<informaltable>
<tgroup cols="3">
<tbody>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_overlaps01.png"/>
</imageobject>
<caption><para><varname>MULTIPOINT</varname> / <varname>MULTIPOINT</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_overlaps02.png"/>
</imageobject>
<caption><para><varname>LINESTRING</varname> / <varname>LINESTRING</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_overlaps03.png"/>
</imageobject>
<caption><para><varname>POLYGON</varname> / <varname>POLYGON</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_overlaps04.png"/>
</imageobject>
</mediaobject>
</informalfigure>
<para>A Point on a LineString is contained,
but since it has lower dimension it does not overlap or cross.</para>
<programlisting>
SELECT ST_Overlaps(a,b) AS overlaps, ST_Crosses(a,b) AS crosses,
ST_Intersects(a, b) AS intersects, ST_Contains(b,a) AS b_contains_a
FROM (SELECT ST_GeomFromText('POINT (100 100)') As a,
ST_GeomFromText('LINESTRING (30 50, 40 160, 160 40, 180 160)') AS b) AS t
overlaps | crosses | intersects | b_contains_a
---------+----------------------+--------------
f | f | t | t
</programlisting>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_overlaps05.png"/>
</imageobject>
</mediaobject>
</informalfigure>
<para>A LineString that partly covers a Polygon intersects and crosses,
but does not overlap since it has different dimension.</para>
<programlisting>
SELECT ST_Overlaps(a,b) AS overlaps, ST_Crosses(a,b) AS crosses,
ST_Intersects(a, b) AS intersects, ST_Contains(a,b) AS contains
FROM (SELECT ST_GeomFromText('POLYGON ((40 170, 90 30, 180 100, 40 170))') AS a,
ST_GeomFromText('LINESTRING(10 10, 190 190)') AS b) AS t;
overlap | crosses | intersects | contains
---------+---------+------------+--------------
f | t | t | f
</programlisting>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_overlaps06.png"/>
</imageobject>
</mediaobject>
</informalfigure>
<para>Two Polygons that intersect but with neither contained by the other overlap,
but do not cross because their intersection has the same dimension.</para>
<programlisting>
SELECT ST_Overlaps(a,b) AS overlaps, ST_Crosses(a,b) AS crosses,
ST_Intersects(a, b) AS intersects, ST_Contains(b, a) AS b_contains_a,
ST_Dimension(a) AS dim_a, ST_Dimension(b) AS dim_b,
ST_Dimension(ST_Intersection(a,b)) AS dim_int
FROM (SELECT ST_GeomFromText('POLYGON ((40 170, 90 30, 180 100, 40 170))') AS a,
ST_GeomFromText('POLYGON ((110 180, 20 60, 130 90, 110 180))') AS b) As t;
overlaps | crosses | intersects | b_contains_a | dim_a | dim_b | dim_int
----------+---------+------------+--------------+-------+-------+-----------
t | f | t | f | 2 | 2 | 2
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Contains"/>, <xref linkend="ST_Crosses"/>, <xref linkend="ST_Dimension"/>, <xref linkend="ST_Intersects"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Relate">
<refnamediv>
<refname>ST_Relate</refname>
<refpurpose>Tests if two geometries have a topological relationship
matching an Intersection Matrix pattern,
or computes their Intersection Matrix
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_Relate</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
<paramdef><type>geometry </type> <parameter>geomB</parameter></paramdef>
<paramdef><type>text </type> <parameter>intersectionMatrixPattern</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>text <function>ST_Relate</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
<paramdef><type>geometry </type> <parameter>geomB</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>text <function>ST_Relate</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
<paramdef><type>geometry </type> <parameter>geomB</parameter></paramdef>
<paramdef><type>integer </type> <parameter>boundaryNodeRule</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
These functions allow testing and evaluating the spatial (topological) relationship between two geometries,
as defined by the <link xlink:href="http://en.wikipedia.org/wiki/DE-9IM">Dimensionally Extended 9-Intersection Model</link> (DE-9IM).
</para>
<para>
The DE-9IM is specified as a 9-element matrix indicating the dimension of the intersections between the
Interior, Boundary and Exterior of two geometries.
It is represented by a 9-character text string using the symbols 'F', '0', '1', '2'
(e.g. <code>'FF1FF0102'</code>).
</para>
<para>
A specific kind of spatial relationship can be tested by matching the intersection
matrix to an <emphasis>intersection matrix pattern</emphasis>.
Patterns can include the additional symbols 'T' (meaning "intersection is non-empty")
and '*' (meaning "any value").
Common spatial relationships are provided by the named functions
<xref linkend="ST_Contains"/>, <xref linkend="ST_ContainsProperly"/>,
<xref linkend="ST_Covers"/>, <xref linkend="ST_CoveredBy"/>,
<xref linkend="ST_Crosses"/>, <xref linkend="ST_Disjoint"/>, <xref linkend="ST_Equals"/>,
<xref linkend="ST_Intersects"/>, <xref linkend="ST_Overlaps"/>, <xref linkend="ST_Touches"/>,
and <xref linkend="ST_Within"/>.
Using an explicit pattern allows testing multiple conditions of intersects, crosses, etc in one step.
It also allows testing spatial relationships which do not have a named spatial relationship function.
For example, the relationship "Interior-Intersects" has the DE-9IM pattern <code>T********</code>,
which is not evaluated by any named predicate.
</para>
<para>
For more information refer to <xref linkend="eval_spatial_rel"/>.
</para>
<para><emphasis role="bold">Variant 1:</emphasis> Tests if two geometries are spatially related
according to the given <varname>intersectionMatrixPattern</varname>.
</para>
<note><para>Unlike most of the named spatial relationship predicates,
this does NOT automatically include an index call.
The reason is that some relationships are true for geometries
which do NOT intersect (e.g. Disjoint). If you are
using a relationship pattern that requires intersection, then include the &&
index call.
</para></note>
<note><para>It is better to use a named relationship function if available,
since they automatically use a spatial index where one exists.
Also, they may implement performance optimizations which are not available
with full relate evaluation.
</para></note>
<para><emphasis role="bold">Variant 2:</emphasis> Returns the DE-9IM matrix string for the
spatial relationship between the two input geometries.
The matrix string can be tested for matching a DE-9IM pattern using <xref linkend="ST_RelateMatch"/>.
</para>
<para><emphasis role="bold">Variant 3:</emphasis> Like variant 2,
but allows specifying a <emphasis role="bold">Boundary Node Rule</emphasis>.
A boundary node rule allows finer control over whether the endpoints of MultiLineStrings
are considered to lie in the DE-9IM Interior or Boundary.
The <varname>boundaryNodeRule</varname> values are:
</para>
<itemizedlist>
<listitem><para><code>1</code>: <emphasis role="bold">OGC-Mod2</emphasis> - line endpoints are in the Boundary if they occur an odd number of times.
This is the rule defined by the OGC SFS standard, and is the default for <function>ST_Relate</function>.
</para></listitem>
<listitem><para><code>2</code>: <emphasis role="bold">Endpoint</emphasis> - all endpoints are in the Boundary.
</para></listitem>
<listitem><para><code>3</code>: <emphasis role="bold">MultivalentEndpoint</emphasis> - endpoints are in the Boundary if they occur more than once.
In other words, the boundary is all the "attached" or "inner" endpoints (but not the "unattached/outer" ones).
</para></listitem>
<listitem><para><code>4</code>: <emphasis role="bold">MonovalentEndpoint</emphasis> - endpoints are in the Boundary if they occur only once.
In other words, the boundary is all the "unattached" or "outer" endpoints.
</para></listitem>
</itemizedlist>
<para>This function is not in the OGC spec, but is implied. see s2.1.13.2</para>
<para>&sfs_compliant; s2.1.1.2 // s2.1.13.3</para>
<para>&sqlmm_compliant; SQL-MM 3: 5.1.25</para>
<para>Performed by the GEOS module</para>
<para role="enhanced" conformance="2.0.0">Enhanced: 2.0.0 - added support for specifying boundary node rule.</para>
<important>
<para role="enhanced" conformance="3.0.0">Enhanced: 3.0.0 enabled support for <varname>GEOMETRYCOLLECTION</varname></para>
</important>
</refsection>
<refsection>
<title>Examples</title>
<para>Using the boolean-valued function to test spatial relationships.</para>
<programlisting>
SELECT ST_Relate('POINT(1 2)', ST_Buffer( 'POINT(1 2)', 2), '0FFFFF212');
st_relate
-----------
t
SELECT ST_Relate(POINT(1 2)', ST_Buffer( 'POINT(1 2)', 2), '*FF*FF212');
st_relate
-----------
t
</programlisting>
<para>Testing a custom spatial relationship pattern as a query condition,
with <code>&&</code> to enable using a spatial index.</para>
<programlisting>
-- Find compounds that properly intersect (not just touch) a poly (Interior Intersects)
SELECT c.* , p.name As poly_name
FROM polys AS p
INNER JOIN compounds As c
ON c.geom && p.geom
AND ST_Relate(p.geom, c.geom,'T********');
</programlisting>
<para>Computing the intersection matrix for spatial relationships.</para>
<programlisting>
SELECT ST_Relate( 'POINT(1 2)',
ST_Buffer( 'POINT(1 2)', 2));
-----------
0FFFFF212
SELECT ST_Relate( 'LINESTRING(1 2, 3 4)',
'LINESTRING(5 6, 7 8)' );
-----------
FF1FF0102
</programlisting>
<para>Using different Boundary Node Rules to compute the spatial relationship
between a LineString and a MultiLineString with a duplicate endpoint <code>(3 3)</code>:
</para>
<itemizedlist>
<listitem><para>Using the <emphasis role="bold">OGC-Mod2</emphasis> rule (1)
the duplicate endpoint is in the <emphasis role="bold">interior</emphasis> of the MultiLineString,
so the DE-9IM matrix entry [aB:bI] is <code>0</code> and [aB:bB] is <code>F</code>.
</para></listitem>
<listitem><para>Using the <emphasis role="bold">Endpoint</emphasis> rule (2)
the duplicate endpoint is in the <emphasis role="bold">boundary</emphasis> of the MultiLineString,
so the DE-9IM matrix entry [aB:bI] is <code>F</code> and [aB:bB] is <code>0</code>.
</para></listitem>
</itemizedlist>
<programlisting>
WITH data AS (SELECT
'LINESTRING(1 1, 3 3)'::geometry AS a_line,
'MULTILINESTRING((3 3, 3 5), (3 3, 5 3))':: geometry AS b_multiline
)
SELECT ST_Relate( a_line, b_multiline, 1) AS bnr_mod2,
ST_Relate( a_line, b_multiline, 2) AS bnr_endpoint
FROM data;
bnr_mod2 | bnr_endpoint
-----------+--------------
FF10F0102 | FF1F00102
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para>
<xref linkend="eval_spatial_rel"/>, <xref linkend="ST_RelateMatch"/>,
<xref linkend="ST_Contains"/>, <xref linkend="ST_ContainsProperly"/>,
<xref linkend="ST_Covers"/>, <xref linkend="ST_CoveredBy"/>,
<xref linkend="ST_Crosses"/>, <xref linkend="ST_Disjoint"/>, <xref linkend="ST_Equals"/>,
<xref linkend="ST_Intersects"/>, <xref linkend="ST_Overlaps"/>,
<xref linkend="ST_Touches"/>, <xref linkend="ST_Within"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_RelateMatch">
<refnamediv>
<refname>ST_RelateMatch</refname>
<refpurpose>Tests if a DE-9IM Intersection Matrix matches an Intersection Matrix pattern
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_RelateMatch</function></funcdef>
<paramdef><type>text </type> <parameter>intersectionMatrix</parameter></paramdef>
<paramdef><type>text </type> <parameter>intersectionMatrixPattern</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Tests if a <link xlink:href="http://en.wikipedia.org/wiki/DE-9IM">Dimensionally Extended 9-Intersection Model</link> (DE-9IM)
<varname>intersectionMatrix</varname> value satisfies
an <varname>intersectionMatrixPattern</varname>.
Intersection matrix values can be computed by <xref linkend="ST_Relate"/>.
</para>
<para>
For more information refer to <xref linkend="eval_spatial_rel"/>.
</para>
<para>Performed by the GEOS module</para>
<para role="availability" conformance="2.0.0">Availability: 2.0.0</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
SELECT ST_RelateMatch('101202FFF', 'TTTTTTFFF') ;
-- result --
t
</programlisting>
<para>Patterns for common spatial relationships
matched against intersection matrix values,
for a line in various positions relative to a polygon</para>
<programlisting>
SELECT pat.name AS relationship, pat.val AS pattern,
mat.name AS position, mat.val AS matrix,
ST_RelateMatch(mat.val, pat.val) AS match
FROM (VALUES ( 'Equality', 'T1FF1FFF1' ),
( 'Overlaps', 'T*T***T**' ),
( 'Within', 'T*F**F***' ),
( 'Disjoint', 'FF*FF****' )) AS pat(name,val)
CROSS JOIN
(VALUES ('non-intersecting', 'FF1FF0212'),
('overlapping', '1010F0212'),
('inside', '1FF0FF212')) AS mat(name,val);
relationship | pattern | position | matrix | match
--------------+-----------+------------------+-----------+-------
Equality | T1FF1FFF1 | non-intersecting | FF1FF0212 | f
Equality | T1FF1FFF1 | overlapping | 1010F0212 | f
Equality | T1FF1FFF1 | inside | 1FF0FF212 | f
Overlaps | T*T***T** | non-intersecting | FF1FF0212 | f
Overlaps | T*T***T** | overlapping | 1010F0212 | t
Overlaps | T*T***T** | inside | 1FF0FF212 | f
Within | T*F**F*** | non-intersecting | FF1FF0212 | f
Within | T*F**F*** | overlapping | 1010F0212 | f
Within | T*F**F*** | inside | 1FF0FF212 | t
Disjoint | FF*FF**** | non-intersecting | FF1FF0212 | t
Disjoint | FF*FF**** | overlapping | 1010F0212 | f
Disjoint | FF*FF**** | inside | 1FF0FF212 | f
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="eval_spatial_rel"/>, <xref linkend="ST_Relate"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Touches">
<refnamediv>
<refname>ST_Touches</refname>
<refpurpose>Tests if two geometries have at least one point in common,
but their interiors do not intersect</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_Touches</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 <varname>TRUE</varname> if A and B intersect,
but their interiors do not intersect. Equivalently, A and B have at least one point in common,
and the common points lie in at least one boundary.
For Point/Point inputs the relationship is always <varname>FALSE</varname>,
since points do not have a boundary.</para>
<para>In mathematical terms:
<emphasis>ST_Touches(A, B) ⇔ (Int(A) ⋂ Int(B) = ∅) ∧ (A ⋂ B ≠ ∅) </emphasis></para>
<para>This relationship holds if the DE-9IM Intersection Matrix for the two geometries matches one of:</para>
<itemizedlist>
<listitem>
<para><markup>FT*******</markup></para>
</listitem>
<listitem>
<para><markup>F**T*****</markup></para>
</listitem>
<listitem>
<para><markup>F***T****</markup></para>
</listitem>
</itemizedlist>
<note><para>&index_aware;
To avoid using an index, use <function>_ST_Touches</function> instead.</para>
</note>
<important>
<para role="enhanced" conformance="3.0.0">Enhanced: 3.0.0 enabled support for <varname>GEOMETRYCOLLECTION</varname></para>
</important>
<para>&sfs_compliant; s2.1.1.2 // s2.1.13.3</para>
<para>&sqlmm_compliant; SQL-MM 3: 5.1.28</para>
</refsection>
<refsection>
<title>Examples</title>
<para>The <function>ST_Touches</function> predicate returns <varname>TRUE</varname> in the following examples.</para>
<informaltable>
<tgroup cols="3">
<tbody>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_touches01.png"/>
</imageobject>
<caption><para><varname>POLYGON</varname> / <varname>POLYGON</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_touches02.png"/>
</imageobject>
<caption><para><varname>POLYGON</varname> / <varname>POLYGON</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_touches03.png"/>
</imageobject>
<caption><para><varname>POLYGON</varname> / <varname>LINESTRING</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
</row>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_touches04.png"/>
</imageobject>
<caption><para><varname>LINESTRING</varname> / <varname>LINESTRING</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_touches05.png"/>
</imageobject>
<caption><para><varname>LINESTRING</varname> / <varname>LINESTRING</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_touches06.png"/>
</imageobject>
<caption><para><varname>POLYGON</varname> / <varname>POINT</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<programlisting>SELECT ST_Touches('LINESTRING(0 0, 1 1, 0 2)'::geometry, 'POINT(1 1)'::geometry);
st_touches
------------
f
(1 row)
SELECT ST_Touches('LINESTRING(0 0, 1 1, 0 2)'::geometry, 'POINT(0 2)'::geometry);
st_touches
------------
t
(1 row)</programlisting>
</refsection>
</refentry>
<refentry xml:id="ST_Within">
<refnamediv>
<refname>ST_Within</refname>
<refpurpose>Tests if every point of A lies in B, and their interiors have a point in common</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_Within</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 geometry A is within geometry B.
A is within B if and only if all points of A lie inside (i.e. in the interior or boundary of) B
(or equivalently, no points of A lie in the exterior of B),
and the interiors of A and B have at least one point in common.
</para>
<para>For this function to make
sense, the source geometries must both be of the same coordinate projection,
having the same SRID.
</para>
<para>In mathematical terms:
<emphasis>ST_Within(A, B) ⇔ (A ⋂ B = A) ∧ (Int(A) ⋂ Int(B) ≠ ∅) </emphasis></para>
<para>The within relation is reflexive: every geometry is within itself.
The relation is antisymmetric: if <code>ST_Within(A,B) = true</code> and <code>ST_Within(B,A) = true</code>, then
the two geometries must be topologically equal (<code>ST_Equals(A,B) = true</code>).</para>
<para>ST_Within is the converse of <xref linkend="ST_Contains"/>.
So, <code>ST_Within(A,B) = ST_Contains(B,A)</code>.</para>
<note><para>Because the interiors must have a common point, a subtlety of the definition is that
lines and points lying fully in the boundary of polygons or lines are <emphasis>not</emphasis> within the geometry.
For further details see <link xlink:href="http://lin-ear-th-inking.blogspot.com/2007/06/subtleties-of-ogc-covers-spatial.html">Subtleties of OGC Covers, Contains, Within</link>.
The <xref linkend="ST_CoveredBy"/> predicate provides a more inclusive relationship.
</para></note>
<note><para>&index_aware;
To avoid index use, use the function <function>_ST_Within</function>.</para></note>
<para>Performed by the GEOS module</para>
<para role="enhanced" conformance="2.3.0">Enhanced: 2.3.0 Enhancement to PIP short-circuit for geometry extended to support MultiPoints with few points. Prior versions only supported point in polygon.</para>
<important>
<para role="enhanced" conformance="3.0.0">Enhanced: 3.0.0 enabled support for <varname>GEOMETRYCOLLECTION</varname></para>
</important>
<important>
<para>Do not use this function with invalid geometries. You will get unexpected results.</para>
</important>
<para>NOTE: this is the "allowable" version that returns a
boolean, not an integer.</para>
<para>&sfs_compliant; s2.1.1.2 // s2.1.13.3
- a.Relate(b, 'T*F**F***')
</para>
<para>&sqlmm_compliant; SQL-MM 3: 5.1.30</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
--a circle within a circle
SELECT ST_Within(smallc,smallc) As smallinsmall,
ST_Within(smallc, bigc) As smallinbig,
ST_Within(bigc,smallc) As biginsmall,
ST_Within(ST_Union(smallc, bigc), bigc) as unioninbig,
ST_Within(bigc, ST_Union(smallc, bigc)) as biginunion,
ST_Equals(bigc, ST_Union(smallc, bigc)) as bigisunion
FROM
(
SELECT ST_Buffer(ST_GeomFromText('POINT(50 50)'), 20) As smallc,
ST_Buffer(ST_GeomFromText('POINT(50 50)'), 40) As bigc) As foo;
--Result
smallinsmall | smallinbig | biginsmall | unioninbig | biginunion | bigisunion
--------------+------------+------------+------------+------------+------------
t | t | f | t | t | t
(1 row)
</programlisting>
<para><inlinemediaobject>
<imageobject>
<imagedata fileref="images/st_within01.png"/>
</imageobject>
</inlinemediaobject> </para>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Contains"/>, <xref linkend="ST_CoveredBy"/>, <xref linkend="ST_Equals"/>, <xref linkend="ST_IsValid"/></para>
</refsection>
</refentry>
</section>
<!-- ============================================================================== -->
<section>
<title>Distance Relationships</title>
<refentry xml:id="ST_3DDWithin">
<refnamediv>
<refname>ST_3DDWithin</refname>
<refpurpose>Tests if two 3D geometries are within a given 3D distance</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_3DDWithin</function></funcdef>
<paramdef><type>geometry </type>
<parameter>g1</parameter></paramdef>
<paramdef><type>geometry </type>
<parameter>g2</parameter></paramdef>
<paramdef><type>double precision </type>
<parameter>distance_of_srid</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns true if the 3D distance between two geometry values is no larger than
distance <varname>distance_of_srid</varname>.
The distance is specified in units defined by the spatial reference system of the geometries.
For this function to make sense
the source geometries must be in the same coordinate system (have the same SRID).
</para>
<note><para>&index_aware;</para></note>
<para>&Z_support;</para>
<!-- Optionally mention supports Polyhedral Surface -->
<para>&P_support;</para>
<para>&sqlmm_compliant; SQL-MM ?</para>
<para role="availability" conformance="2.0.0">Availability: 2.0.0</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
-- Geometry example - units in meters (SRID: 2163 US National Atlas Equal area) (3D point and line compared 2D point and line)
-- Note: currently no vertical datum support so Z is not transformed and assumed to be same units as final.
SELECT ST_3DDWithin(
ST_Transform(ST_GeomFromEWKT('SRID=4326;POINT(-72.1235 42.3521 4)'),2163),
ST_Transform(ST_GeomFromEWKT('SRID=4326;LINESTRING(-72.1260 42.45 15, -72.123 42.1546 20)'),2163),
126.8
) As within_dist_3d,
ST_DWithin(
ST_Transform(ST_GeomFromEWKT('SRID=4326;POINT(-72.1235 42.3521 4)'),2163),
ST_Transform(ST_GeomFromEWKT('SRID=4326;LINESTRING(-72.1260 42.45 15, -72.123 42.1546 20)'),2163),
126.8
) As within_dist_2d;
within_dist_3d | within_dist_2d
----------------+----------------
f | t
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_3DDFullyWithin"/>,
<xref linkend="ST_DWithin"/>, <xref linkend="ST_DFullyWithin"/>,
<xref linkend="ST_3DDistance"/>, <xref linkend="ST_Distance"/>,
<xref linkend="ST_3DMaxDistance"/>, <xref linkend="ST_Transform"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_3DDFullyWithin">
<refnamediv>
<refname>ST_3DDFullyWithin</refname>
<refpurpose>Tests if two 3D geometries are entirely within a given 3D distance</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_3DDFullyWithin</function></funcdef>
<paramdef><type>geometry </type>
<parameter>g1</parameter></paramdef>
<paramdef><type>geometry </type>
<parameter>g2</parameter></paramdef>
<paramdef><type>double precision </type>
<parameter>distance</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns true if the 3D geometries are fully within the specified distance
of one another. The distance is specified in units defined by the
spatial reference system of the geometries. For this function to make
sense, the source geometries must both be of the same coordinate projection,
having the same SRID.</para>
<note><para>&index_aware;</para></note>
<para role="availability" conformance="2.0.0">Availability: 2.0.0</para>
<para>&Z_support;</para>
<!-- Optionally mention supports Polyhedral Surface -->
<para>&P_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
-- This compares the difference between fully within and distance within as well
-- as the distance fully within for the 2D footprint of the line/point vs. the 3d fully within
SELECT ST_3DDFullyWithin(geom_a, geom_b, 10) as D3DFullyWithin10, ST_3DDWithin(geom_a, geom_b, 10) as D3DWithin10,
ST_DFullyWithin(geom_a, geom_b, 20) as D2DFullyWithin20,
ST_3DDFullyWithin(geom_a, geom_b, 20) as D3DFullyWithin20 from
(select ST_GeomFromEWKT('POINT(1 1 2)') as geom_a,
ST_GeomFromEWKT('LINESTRING(1 5 2, 2 7 20, 1 9 100, 14 12 3)') as geom_b) t1;
d3dfullywithin10 | d3dwithin10 | d2dfullywithin20 | d3dfullywithin20
------------------+-------------+------------------+------------------
f | t | t | f </programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_3DDWithin"/>,
<xref linkend="ST_DWithin"/>, <xref linkend="ST_DFullyWithin"/>,
<xref linkend="ST_3DMaxDistance"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_DFullyWithin">
<refnamediv>
<refname>ST_DFullyWithin</refname>
<refpurpose>Tests if a geometry is entirely inside a distance of another</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_DFullyWithin</function></funcdef>
<paramdef><type>geometry </type>
<parameter>g1</parameter></paramdef>
<paramdef><type>geometry </type>
<parameter>g2</parameter></paramdef>
<paramdef><type>double precision </type>
<parameter>distance</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns true if <code>g2</code> is entirely within
<code>distance</code> of <code>g1</code>. Visually, the
condition is true if <code>g2</code> is contained within
a <code>distance</code> buffer of <code>g1</code>.
The distance is specified in units defined by the
spatial reference system of the geometries.</para>
<note><para>&index_aware;</para></note>
<para role="availability" conformance="1.5.0">Availability: 1.5.0</para>
<para role="changed" conformance="3.5.0">Changed: 3.5.0 : the logic behind the function now uses a test of containment within a buffer, rather than the ST_MaxDistance algorithm. Results will differ from prior versions, but should be closer to user expectations.</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT
ST_DFullyWithin(geom_a, geom_b, 10) AS DFullyWithin10,
ST_DWithin(geom_a, geom_b, 10) AS DWithin10,
ST_DFullyWithin(geom_a, geom_b, 20) AS DFullyWithin20
FROM (VALUES
('POINT(1 1)', 'LINESTRING(1 5, 2 7, 1 9, 14 12)')
) AS v(geom_a, geom_b)
dfullywithin10 | dwithin10 | dfullywithin20
----------------+-----------+----------------
f | t | t
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_MaxDistance"/>,
<xref linkend="ST_DWithin"/>, <xref linkend="ST_3DDWithin"/>, <xref linkend="ST_3DDFullyWithin"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_DWithin">
<refnamediv>
<refname>ST_DWithin</refname>
<refpurpose>Tests if two geometries are within a given distance</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_DWithin</function></funcdef>
<paramdef><type>geometry </type>
<parameter>g1</parameter></paramdef>
<paramdef><type>geometry </type>
<parameter>g2</parameter></paramdef>
<paramdef><type>double precision </type>
<parameter>distance_of_srid</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>boolean <function>ST_DWithin</function></funcdef>
<paramdef><type>geography </type>
<parameter>gg1</parameter></paramdef>
<paramdef><type>geography </type>
<parameter>gg2</parameter></paramdef>
<paramdef><type>double precision </type>
<parameter>distance_meters</parameter></paramdef>
<paramdef choice="opt"><type>boolean </type>
<parameter>use_spheroid = true</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns true if the geometries are within a given distance</para>
<para>For <type>geometry</type>: The distance is specified in units defined by the
spatial reference system of the geometries. For this function to make
sense, the source geometries must be in the same coordinate system
(have the same SRID).</para>
<para>For <type>geography</type>: units are in meters and distance measurement
defaults to <varname>use_spheroid = true</varname>.
For faster evaluation use <varname>use_spheroid = false</varname> to measure on the sphere.
</para>
<note><para>Use <xref linkend="ST_3DDWithin"/> for 3D geometries.</para></note>
<note>
<para>This function call includes a bounding box
comparison that makes use of any indexes that are available on
the geometries.</para>
</note>
<para>&sfs_compliant;</para>
<para role="availability" conformance="1.5.0">Availability: 1.5.0 support for geography was introduced</para>
<para role="enhanced" conformance="2.1.0">Enhanced: 2.1.0 improved speed for geography. See <link xlink:href="http://blog.opengeo.org/2012/07/12/making-geography-faster/">Making Geography faster</link> for details.</para>
<para role="enhanced" conformance="2.1.0">Enhanced: 2.1.0 support for curved geometries was introduced.</para>
<para>Prior to 1.3, <xref linkend="ST_Expand"/> was commonly used in conjunction with && and ST_Distance to
test for distance, and in pre-1.3.4 this function used that logic.
From 1.3.4, ST_DWithin uses a faster short-circuit distance function.</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
-- Find the nearest hospital to each school
-- that is within 3000 units of the school.
-- We do an ST_DWithin search to utilize indexes to limit our search list
-- that the non-indexable ST_Distance needs to process
-- If the units of the spatial reference is meters then units would be meters
SELECT DISTINCT ON (s.gid) s.gid, s.school_name, s.geom, h.hospital_name
FROM schools s
LEFT JOIN hospitals h ON ST_DWithin(s.geom, h.geom, 3000)
ORDER BY s.gid, ST_Distance(s.geom, h.geom);
-- The schools with no close hospitals
-- Find all schools with no hospital within 3000 units
-- away from the school. Units is in units of spatial ref (e.g. meters, feet, degrees)
SELECT s.gid, s.school_name
FROM schools s
LEFT JOIN hospitals h ON ST_DWithin(s.geom, h.geom, 3000)
WHERE h.gid IS NULL;
-- Find broadcasting towers that receiver with limited range can receive.
-- Data is geometry in Spherical Mercator (SRID=3857), ranges are approximate.
-- Create geometry index that will check proximity limit of user to tower
CREATE INDEX ON broadcasting_towers using gist (geom);
-- Create geometry index that will check proximity limit of tower to user
CREATE INDEX ON broadcasting_towers using gist (ST_Expand(geom, sending_range));
-- Query towers that 4-kilometer receiver in Minsk Hackerspace can get
-- Note: two conditions, because shorter LEAST(b.sending_range, 4000) will not use index.
SELECT b.tower_id, b.geom
FROM broadcasting_towers b
WHERE ST_DWithin(b.geom, 'SRID=3857;POINT(3072163.4 7159374.1)', 4000)
AND ST_DWithin(b.geom, 'SRID=3857;POINT(3072163.4 7159374.1)', b.sending_range);
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Distance"/>, <xref linkend="ST_3DDWithin"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_PointInsideCircle">
<refnamediv>
<refname>ST_PointInsideCircle</refname>
<refpurpose>Tests if a point geometry is inside a circle defined by a center and radius</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_PointInsideCircle</function></funcdef>
<paramdef><type>geometry </type> <parameter>a_point</parameter></paramdef>
<paramdef><type>float </type> <parameter>center_x</parameter></paramdef>
<paramdef><type>float </type> <parameter>center_y</parameter></paramdef>
<paramdef><type>float </type> <parameter>radius</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns true if the geometry is a point and is inside the
circle with center <varname>center_x</varname>,<varname>center_y</varname>
and radius <varname>radius</varname>.
</para>
<warning><para>Does not use spatial indexes. Use <xref linkend="ST_DWithin"/> instead.</para></warning>
<para role="availability" conformance="1.2">Availability: 1.2</para>
<para role="changed" conformance="2.2.0">Changed: 2.2.0 In prior versions this was called ST_Point_Inside_Circle</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_PointInsideCircle(ST_Point(1,2), 0.5, 2, 3);
st_pointinsidecircle
------------------------
t
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_DWithin"/></para>
</refsection>
</refentry>
</section>
</section>
|