PostGIS  2.5.7dev-r@@SVN_REVISION@@

◆ contains()

Datum contains ( PG_FUNCTION_ARGS  )

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

1625 {
1626  GSERIALIZED *geom1;
1627  GSERIALIZED *geom2;
1628  GEOSGeometry *g1, *g2;
1629  GBOX box1, box2;
1630  int result;
1631  PrepGeomCache *prep_cache;
1632 
1633  geom1 = PG_GETARG_GSERIALIZED_P(0);
1634  geom2 = PG_GETARG_GSERIALIZED_P(1);
1635 
1636  errorIfGeometryCollection(geom1,geom2);
1638 
1639  /* A.Contains(Empty) == FALSE */
1640  if ( gserialized_is_empty(geom1) || gserialized_is_empty(geom2) )
1641  PG_RETURN_BOOL(false);
1642 
1643  POSTGIS_DEBUG(3, "contains called.");
1644 
1645  /*
1646  ** short-circuit 1: if geom2 bounding box is not completely inside
1647  ** geom1 bounding box we can return FALSE.
1648  */
1649  if ( gserialized_get_gbox_p(geom1, &box1) &&
1650  gserialized_get_gbox_p(geom2, &box2) )
1651  {
1652  if (!gbox_contains_2d(&box1, &box2)) PG_RETURN_BOOL(false);
1653  }
1654 
1655  /*
1656  ** short-circuit 2: if geom2 is a point and geom1 is a polygon
1657  ** call the point-in-polygon function.
1658  */
1659  if (is_poly(geom1) && is_point(geom2))
1660  {
1661  GSERIALIZED* gpoly = is_poly(geom1) ? geom1 : geom2;
1662  GSERIALIZED* gpoint = is_point(geom1) ? geom1 : geom2;
1663  RTREE_POLY_CACHE* cache = GetRtreeCache(fcinfo, gpoly);
1664  int retval;
1665 
1666  POSTGIS_DEBUG(3, "Point in Polygon test requested...short-circuiting.");
1667  if (gserialized_get_type(gpoint) == POINTTYPE)
1668  {
1669  LWGEOM* point = lwgeom_from_gserialized(gpoint);
1670  int pip_result = pip_short_circuit(cache, lwgeom_as_lwpoint(point), gpoly);
1671  lwgeom_free(point);
1672 
1673  retval = (pip_result == 1); /* completely inside */
1674  }
1675  else if (gserialized_get_type(gpoint) == MULTIPOINTTYPE)
1676  {
1678  uint32_t i;
1679  int found_completely_inside = LW_FALSE;
1680 
1681  retval = LW_TRUE;
1682  for (i = 0; i < mpoint->ngeoms; i++)
1683  {
1684  /* We need to find at least one point that's completely inside the
1685  * polygons (pip_result == 1). As long as we have one point that's
1686  * completely inside, we can have as many as we want on the boundary
1687  * itself. (pip_result == 0)
1688  */
1689  int pip_result = pip_short_circuit(cache, mpoint->geoms[i], gpoly);
1690  if (pip_result == 1)
1691  found_completely_inside = LW_TRUE;
1692 
1693  if (pip_result == -1) /* completely outside */
1694  {
1695  retval = LW_FALSE;
1696  break;
1697  }
1698  }
1699 
1700  retval = retval && found_completely_inside;
1701  lwmpoint_free(mpoint);
1702  }
1703  else
1704  {
1705  /* Never get here */
1706  elog(ERROR,"Type isn't point or multipoint!");
1707  PG_RETURN_NULL();
1708  }
1709 
1710  PG_FREE_IF_COPY(geom1, 0);
1711  PG_FREE_IF_COPY(geom2, 1);
1712  PG_RETURN_BOOL(retval);
1713  }
1714  else
1715  {
1716  POSTGIS_DEBUGF(3, "Contains: type1: %d, type2: %d", gserialized_get_type(geom1), gserialized_get_type(geom2));
1717  }
1718 
1719  initGEOS(lwpgnotice, lwgeom_geos_error);
1720 
1721  prep_cache = GetPrepGeomCache( fcinfo, geom1, 0 );
1722 
1723  if ( prep_cache && prep_cache->prepared_geom && prep_cache->gcache.argnum == 1 )
1724  {
1725  g1 = POSTGIS2GEOS(geom2);
1726  if (!g1)
1727  HANDLE_GEOS_ERROR("Geometry could not be converted to GEOS");
1728 
1729  POSTGIS_DEBUG(4, "containsPrepared: cache is live, running preparedcontains");
1730  result = GEOSPreparedContains( prep_cache->prepared_geom, g1);
1731  GEOSGeom_destroy(g1);
1732  }
1733  else
1734  {
1735  g1 = POSTGIS2GEOS(geom1);
1736  if (!g1) HANDLE_GEOS_ERROR("First argument geometry could not be converted to GEOS");
1737  g2 = POSTGIS2GEOS(geom2);
1738  if (!g2)
1739  {
1740  HANDLE_GEOS_ERROR("Second argument geometry could not be converted to GEOS");
1741  GEOSGeom_destroy(g1);
1742  }
1743  POSTGIS_DEBUG(4, "containsPrepared: cache is not ready, running standard contains");
1744  result = GEOSContains( g1, g2);
1745  GEOSGeom_destroy(g1);
1746  GEOSGeom_destroy(g2);
1747  }
1748 
1749  if (result == 2) HANDLE_GEOS_ERROR("GEOSContains");
1750 
1751  PG_FREE_IF_COPY(geom1, 0);
1752  PG_FREE_IF_COPY(geom2, 1);
1753 
1754  PG_RETURN_BOOL(result);
1755 
1756 }
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: g_box.c:346
int32_t gserialized_get_srid(const GSERIALIZED *s)
Extract the SRID from the serialized form (it is packed into three bytes so this is a handy function)...
Definition: g_serialized.c:100
LWGEOM * lwgeom_from_gserialized(const GSERIALIZED *g)
Allocate a new LWGEOM from a GSERIALIZED.
int gserialized_is_empty(const GSERIALIZED *g)
Check if a GSERIALIZED is empty without deserializing first.
Definition: g_serialized.c:179
int gserialized_get_gbox_p(const GSERIALIZED *g, GBOX *box)
Read the bounding box off a serialization and calculate one if it is not already there.
Definition: g_serialized.c:640
uint32_t gserialized_get_type(const GSERIALIZED *s)
Extract the geometry type from the serialized form (it hides in the anonymous data area,...
Definition: g_serialized.c:86
void lwgeom_geos_error(const char *fmt,...)
#define LW_FALSE
Definition: liblwgeom.h:77
void lwmpoint_free(LWMPOINT *mpt)
Definition: lwmpoint.c:72
LWMPOINT * lwgeom_as_lwmpoint(const LWGEOM *lwgeom)
Definition: lwgeom.c:233
void lwgeom_free(LWGEOM *geom)
Definition: lwgeom.c:1144
#define MULTIPOINTTYPE
Definition: liblwgeom.h:88
#define POINTTYPE
LWTYPE numbers, used internally by PostGIS.
Definition: liblwgeom.h:85
LWPOINT * lwgeom_as_lwpoint(const LWGEOM *lwgeom)
Definition: lwgeom.c:161
void error_if_srid_mismatch(int srid1, int srid2)
Definition: lwutil.c:338
#define LW_TRUE
Return types for functions with status returns.
Definition: liblwgeom.h:76
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 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)
void errorIfGeometryCollection(GSERIALIZED *g1, GSERIALIZED *g2)
Throws an ereport ERROR if either geometry is a COLLECTIONTYPE.
GEOSGeometry * POSTGIS2GEOS(GSERIALIZED *pglwgeom)
static char is_poly(const GSERIALIZED *g)
uint32_t ngeoms
Definition: liblwgeom.h:471
LWPOINT ** geoms
Definition: liblwgeom.h:473
const GEOSPreparedGeometry * prepared_geom
The tree structure used for fast P-i-P tests by point_in_multipolygon_rtree()
Definition: lwgeom_rtree.h:59
unsigned int uint32_t
Definition: uthash.h:78

References error_if_srid_mismatch(), errorIfGeometryCollection(), gbox_contains_2d(), PrepGeomCache::gcache, LWMPOINT::geoms, GetPrepGeomCache(), GetRtreeCache(), gserialized_get_gbox_p(), gserialized_get_srid(), 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(), and rt_raster_contains_properly().

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