PostGIS  3.0.6dev-r@@SVN_REVISION@@

◆ contains()

Datum contains ( PG_FUNCTION_ARGS  )

Definition at line 1678 of file postgis/lwgeom_geos.c.

1679 {
1680  GSERIALIZED *geom1 = PG_GETARG_GSERIALIZED_P(0);
1681  GSERIALIZED *geom2 = PG_GETARG_GSERIALIZED_P(1);
1682  int result;
1683  GEOSGeometry *g1, *g2;
1684  GBOX box1, box2;
1685  PrepGeomCache *prep_cache;
1686  gserialized_error_if_srid_mismatch(geom1, geom2, __func__);
1687 
1688  /* A.Contains(Empty) == FALSE */
1689  if (gserialized_is_empty(geom1) || gserialized_is_empty(geom2))
1690  PG_RETURN_BOOL(false);
1691 
1692  POSTGIS_DEBUG(3, "contains called.");
1693 
1694  /*
1695  ** short-circuit 1: if geom2 bounding box is not completely inside
1696  ** geom1 bounding box we can return FALSE.
1697  */
1698  if (gserialized_get_gbox_p(geom1, &box1) &&
1699  gserialized_get_gbox_p(geom2, &box2))
1700  {
1701  if (!gbox_contains_2d(&box1, &box2))
1702  PG_RETURN_BOOL(false);
1703  }
1704 
1705  /*
1706  ** short-circuit 2: if geom2 is a point and geom1 is a polygon
1707  ** call the point-in-polygon function.
1708  */
1709  if (is_poly(geom1) && is_point(geom2))
1710  {
1711  GSERIALIZED* gpoly = is_poly(geom1) ? geom1 : geom2;
1712  GSERIALIZED* gpoint = is_point(geom1) ? geom1 : geom2;
1713  RTREE_POLY_CACHE* cache = GetRtreeCache(fcinfo, gpoly);
1714  int retval;
1715 
1716  POSTGIS_DEBUG(3, "Point in Polygon test requested...short-circuiting.");
1717  if (gserialized_get_type(gpoint) == POINTTYPE)
1718  {
1719  LWGEOM* point = lwgeom_from_gserialized(gpoint);
1720  int pip_result = pip_short_circuit(cache, lwgeom_as_lwpoint(point), gpoly);
1721  lwgeom_free(point);
1722 
1723  retval = (pip_result == 1); /* completely inside */
1724  }
1725  else if (gserialized_get_type(gpoint) == MULTIPOINTTYPE)
1726  {
1728  uint32_t i;
1729  int found_completely_inside = LW_FALSE;
1730 
1731  retval = LW_TRUE;
1732  for (i = 0; i < mpoint->ngeoms; i++)
1733  {
1734  /* We need to find at least one point that's completely inside the
1735  * polygons (pip_result == 1). As long as we have one point that's
1736  * completely inside, we can have as many as we want on the boundary
1737  * itself. (pip_result == 0)
1738  */
1739  int pip_result = pip_short_circuit(cache, mpoint->geoms[i], gpoly);
1740  if (pip_result == 1)
1741  found_completely_inside = LW_TRUE;
1742 
1743  if (pip_result == -1) /* completely outside */
1744  {
1745  retval = LW_FALSE;
1746  break;
1747  }
1748  }
1749 
1750  retval = retval && found_completely_inside;
1751  lwmpoint_free(mpoint);
1752  }
1753  else
1754  {
1755  /* Never get here */
1756  elog(ERROR,"Type isn't point or multipoint!");
1757  PG_RETURN_BOOL(false);
1758  }
1759 
1760  return retval > 0;
1761  }
1762  else
1763  {
1764  POSTGIS_DEBUGF(3, "Contains: type1: %d, type2: %d", gserialized_get_type(geom1), gserialized_get_type(geom2));
1765  }
1766 
1767  initGEOS(lwpgnotice, lwgeom_geos_error);
1768 
1769  prep_cache = GetPrepGeomCache( fcinfo, geom1, 0 );
1770 
1771  if ( prep_cache && prep_cache->prepared_geom && prep_cache->gcache.argnum == 1 )
1772  {
1773  g1 = POSTGIS2GEOS(geom2);
1774  if (!g1)
1775  HANDLE_GEOS_ERROR("Geometry could not be converted to GEOS");
1776 
1777  POSTGIS_DEBUG(4, "containsPrepared: cache is live, running preparedcontains");
1778  result = GEOSPreparedContains( prep_cache->prepared_geom, g1);
1779  GEOSGeom_destroy(g1);
1780  }
1781  else
1782  {
1783  g1 = POSTGIS2GEOS(geom1);
1784  if (!g1) HANDLE_GEOS_ERROR("First argument geometry could not be converted to GEOS");
1785  g2 = POSTGIS2GEOS(geom2);
1786  if (!g2)
1787  {
1788  HANDLE_GEOS_ERROR("Second argument geometry could not be converted to GEOS");
1789  GEOSGeom_destroy(g1);
1790  }
1791  POSTGIS_DEBUG(4, "containsPrepared: cache is not ready, running standard contains");
1792  result = GEOSContains( g1, g2);
1793  GEOSGeom_destroy(g1);
1794  GEOSGeom_destroy(g2);
1795  }
1796 
1797  if (result == 2) HANDLE_GEOS_ERROR("GEOSContains");
1798 
1799  PG_FREE_IF_COPY(geom1, 0);
1800  PG_FREE_IF_COPY(geom2, 1);
1801  PG_RETURN_BOOL(result > 0);
1802 }
int gbox_contains_2d(const GBOX *g1, const GBOX *g2)
Return LW_TRUE if the first GBOX contains the second on the 2d plane, LW_FALSE otherwise.
Definition: gbox.c:339
void gserialized_error_if_srid_mismatch(const GSERIALIZED *g1, const GSERIALIZED *g2, const char *funcname)
Definition: gserialized.c:404
int gserialized_get_gbox_p(const GSERIALIZED *g, GBOX *gbox)
Read the box from the GSERIALIZED or calculate it if necessary.
Definition: gserialized.c:65
LWGEOM * lwgeom_from_gserialized(const GSERIALIZED *g)
Allocate a new LWGEOM from a GSERIALIZED.
Definition: gserialized.c:239
int gserialized_is_empty(const GSERIALIZED *g)
Check if a GSERIALIZED is empty without deserializing first.
Definition: gserialized.c:152
uint32_t gserialized_get_type(const GSERIALIZED *g)
Extract the geometry type from the serialized form (it hides in the anonymous data area,...
Definition: gserialized.c:89
void lwgeom_geos_error(const char *fmt,...)
#define LW_FALSE
Definition: liblwgeom.h:108
void lwmpoint_free(LWMPOINT *mpt)
Definition: lwmpoint.c:72
LWMPOINT * lwgeom_as_lwmpoint(const LWGEOM *lwgeom)
Definition: lwgeom.c:224
void lwgeom_free(LWGEOM *geom)
Definition: lwgeom.c:1138
#define MULTIPOINTTYPE
Definition: liblwgeom.h:119
#define POINTTYPE
LWTYPE numbers, used internally by PostGIS.
Definition: liblwgeom.h:116
#define LW_TRUE
Return types for functions with status returns.
Definition: liblwgeom.h:107
PrepGeomCache * GetPrepGeomCache(FunctionCallInfo fcinfo, GSERIALIZED *g1, GSERIALIZED *g2)
Given a couple potential geometries and a function call context, return a prepared structure for one ...
RTREE_POLY_CACHE * GetRtreeCache(FunctionCallInfo fcinfo, GSERIALIZED *g1)
Checks for a cache hit against the provided geometry and returns a pre-built index structure (RTREE_P...
Definition: lwgeom_rtree.c:432
static LWPOINT * lwgeom_as_lwpoint(const LWGEOM *lwgeom)
Definition: lwinline.h:121
static int pip_short_circuit(RTREE_POLY_CACHE *poly_cache, LWPOINT *point, GSERIALIZED *gpoly)
#define HANDLE_GEOS_ERROR(label)
static char is_point(const GSERIALIZED *g)
GEOSGeometry * POSTGIS2GEOS(GSERIALIZED *pglwgeom)
static char is_poly(const GSERIALIZED *g)
uint32_t ngeoms
Definition: liblwgeom.h:524
LWPOINT ** geoms
Definition: liblwgeom.h:519
const GEOSPreparedGeometry * prepared_geom
The tree structure used for fast P-i-P tests by point_in_multipolygon_rtree()
Definition: lwgeom_rtree.h:59

References gbox_contains_2d(), PrepGeomCache::gcache, LWMPOINT::geoms, GetPrepGeomCache(), GetRtreeCache(), gserialized_error_if_srid_mismatch(), gserialized_get_gbox_p(), gserialized_get_type(), gserialized_is_empty(), HANDLE_GEOS_ERROR, is_point(), is_poly(), LW_FALSE, LW_TRUE, lwgeom_as_lwmpoint(), lwgeom_as_lwpoint(), lwgeom_free(), lwgeom_from_gserialized(), lwgeom_geos_error(), lwmpoint_free(), MULTIPOINTTYPE, LWMPOINT::ngeoms, pip_short_circuit(), POINTTYPE, POSTGIS2GEOS(), and PrepGeomCache::prepared_geom.

Referenced by _lwt_AddFaceSplit(), _lwt_AddPoint(), _lwt_CheckEdgeCrossing(), _lwt_FindFaceContainingRing(), lwpoly_split_by_line(), lwpoly_to_points(), rt_raster_contains(), rt_raster_contains_properly(), and within().

Here is the call graph for this function:
Here is the caller graph for this function: