PostGIS  2.5.2dev-r@@SVN_REVISION@@

◆ contains()

Datum contains ( PG_FUNCTION_ARGS  )

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

References containsproperly(), 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, PG_FUNCTION_INFO_V1(), 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(), and overlaps().

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