PostGIS  3.0.0dev-r@@SVN_REVISION@@

◆ contains()

Datum contains ( PG_FUNCTION_ARGS  )

Definition at line 1625 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().

1626 {
1627  GSERIALIZED *geom1;
1628  GSERIALIZED *geom2;
1629  GEOSGeometry *g1, *g2;
1630  GBOX box1, box2;
1631  int result;
1632  PrepGeomCache *prep_cache;
1633 
1634  geom1 = PG_GETARG_GSERIALIZED_P(0);
1635  geom2 = PG_GETARG_GSERIALIZED_P(1);
1636 
1637  errorIfGeometryCollection(geom1,geom2);
1639 
1640  /* A.Contains(Empty) == FALSE */
1641  if ( gserialized_is_empty(geom1) || gserialized_is_empty(geom2) )
1642  PG_RETURN_BOOL(false);
1643 
1644  POSTGIS_DEBUG(3, "contains called.");
1645 
1646  /*
1647  ** short-circuit 1: if geom2 bounding box is not completely inside
1648  ** geom1 bounding box we can return FALSE.
1649  */
1650  if ( gserialized_get_gbox_p(geom1, &box1) &&
1651  gserialized_get_gbox_p(geom2, &box2) )
1652  {
1653  if (!gbox_contains_2d(&box1, &box2)) PG_RETURN_BOOL(false);
1654  }
1655 
1656  /*
1657  ** short-circuit 2: if geom2 is a point and geom1 is a polygon
1658  ** call the point-in-polygon function.
1659  */
1660  if (is_poly(geom1) && is_point(geom2))
1661  {
1662  GSERIALIZED* gpoly = is_poly(geom1) ? geom1 : geom2;
1663  GSERIALIZED* gpoint = is_point(geom1) ? geom1 : geom2;
1664  RTREE_POLY_CACHE* cache = GetRtreeCache(fcinfo, gpoly);
1665  int retval;
1666 
1667  POSTGIS_DEBUG(3, "Point in Polygon test requested...short-circuiting.");
1668  if (gserialized_get_type(gpoint) == POINTTYPE)
1669  {
1670  LWGEOM* point = lwgeom_from_gserialized(gpoint);
1671  int pip_result = pip_short_circuit(cache, lwgeom_as_lwpoint(point), gpoly);
1672  lwgeom_free(point);
1673 
1674  retval = (pip_result == 1); /* completely inside */
1675  }
1676  else if (gserialized_get_type(gpoint) == MULTIPOINTTYPE)
1677  {
1679  uint32_t i;
1680  int found_completely_inside = LW_FALSE;
1681 
1682  retval = LW_TRUE;
1683  for (i = 0; i < mpoint->ngeoms; i++)
1684  {
1685  /* We need to find at least one point that's completely inside the
1686  * polygons (pip_result == 1). As long as we have one point that's
1687  * completely inside, we can have as many as we want on the boundary
1688  * itself. (pip_result == 0)
1689  */
1690  int pip_result = pip_short_circuit(cache, mpoint->geoms[i], gpoly);
1691  if (pip_result == 1)
1692  found_completely_inside = LW_TRUE;
1693 
1694  if (pip_result == -1) /* completely outside */
1695  {
1696  retval = LW_FALSE;
1697  break;
1698  }
1699  }
1700 
1701  retval = retval && found_completely_inside;
1702  lwmpoint_free(mpoint);
1703  }
1704  else
1705  {
1706  /* Never get here */
1707  elog(ERROR,"Type isn't point or multipoint!");
1708  PG_RETURN_NULL();
1709  }
1710 
1711  PG_FREE_IF_COPY(geom1, 0);
1712  PG_FREE_IF_COPY(geom2, 1);
1713  PG_RETURN_BOOL(retval);
1714  }
1715  else
1716  {
1717  POSTGIS_DEBUGF(3, "Contains: type1: %d, type2: %d", gserialized_get_type(geom1), gserialized_get_type(geom2));
1718  }
1719 
1720  initGEOS(lwpgnotice, lwgeom_geos_error);
1721 
1722  prep_cache = GetPrepGeomCache( fcinfo, geom1, 0 );
1723 
1724  if ( prep_cache && prep_cache->prepared_geom && prep_cache->gcache.argnum == 1 )
1725  {
1726  g1 = POSTGIS2GEOS(geom2);
1727  if (!g1)
1728  HANDLE_GEOS_ERROR("Geometry could not be converted to GEOS");
1729 
1730  POSTGIS_DEBUG(4, "containsPrepared: cache is live, running preparedcontains");
1731  result = GEOSPreparedContains( prep_cache->prepared_geom, g1);
1732  GEOSGeom_destroy(g1);
1733  }
1734  else
1735  {
1736  g1 = POSTGIS2GEOS(geom1);
1737  if (!g1) HANDLE_GEOS_ERROR("First argument geometry could not be converted to GEOS");
1738  g2 = POSTGIS2GEOS(geom2);
1739  if (!g2)
1740  {
1741  HANDLE_GEOS_ERROR("Second argument geometry could not be converted to GEOS");
1742  GEOSGeom_destroy(g1);
1743  }
1744  POSTGIS_DEBUG(4, "containsPrepared: cache is not ready, running standard contains");
1745  result = GEOSContains( g1, g2);
1746  GEOSGeom_destroy(g1);
1747  GEOSGeom_destroy(g2);
1748  }
1749 
1750  if (result == 2) HANDLE_GEOS_ERROR("GEOSContains");
1751 
1752  PG_FREE_IF_COPY(geom1, 0);
1753  PG_FREE_IF_COPY(geom2, 1);
1754 
1755  PG_RETURN_BOOL(result);
1756 
1757 }
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:639
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
static LWPOINT * lwgeom_as_lwpoint(const LWGEOM *lwgeom)
Definition: lwinline.h:100
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:1128
#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:336
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:178
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:224
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:99
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: