geos.GEOSPrepare ⇒ number ⏏
Create a Prepared Geometry. The caller retains ownership of the base geometry, and after processing is complete, must free both the prepared and the base geometry. (Ideally, destroy the prepared geometry first, as it has an internal reference to the base geometry.)
Kind: global property of geos
Returns: number - A prepared geometry. Caller is responsible for freeing with GEOSPreparedGeom_destroy()
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | The base geometry to wrap in a prepared geometry. |
geos.GEOSPrepare_r ⇒ number ⏏
Create a Prepared Geometry. The caller retains ownership of the base geometry, and after processing is complete, must free both the prepared and the base geometry. (Ideally, destroy the prepared geometry first, as it has an internal reference to the base geometry.)
Kind: global property of geos
Returns: number - A prepared geometry. Caller is responsible for freeing with GEOSPreparedGeom_destroy()
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | The base geometry to wrap in a prepared geometry. |
geos.GEOSPreparedContains ⇒ number ⏏
Use a GEOSPreparedGeometry do a high performance calculation of whether the provided geometry is contained.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedContainsProperly ⇒ number ⏏
Use a GEOSPreparedGeometry do a high performance calculation of whether the provided geometry is contained properly.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedContainsProperly_r ⇒ number ⏏
Use a GEOSPreparedGeometry do a high performance calculation of whether the provided geometry is contained properly.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedContainsXY ⇒ number ⏏
Use a GEOSPreparedGeometry do a high performance calculation of whether the provided point is contained.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| x | number | x coordinate of point to test |
| y | number | y coordinate of point to test |
geos.GEOSPreparedContainsXY_r ⇒ number ⏏
Use a GEOSPreparedGeometry do a high performance calculation of whether the provided point is contained.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| x | number | x coordinate of point to test |
| y | number | y coordinate of point to test |
geos.GEOSPreparedContains_r ⇒ number ⏏
Use a GEOSPreparedGeometry do a high performance calculation of whether the provided geometry is contained.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedCoveredBy ⇒ number ⏏
Using a GEOSPreparedGeometry do a high performance calculation of whether the provided geometry is covered by.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedCoveredBy_r ⇒ number ⏏
Using a GEOSPreparedGeometry do a high performance calculation of whether the provided geometry is covered by.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedCovers ⇒ number ⏏
Using a GEOSPreparedGeometry do a high performance calculation of whether the provided geometry covers.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedCovers_r ⇒ number ⏏
Using a GEOSPreparedGeometry do a high performance calculation of whether the provided geometry covers.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedCrosses ⇒ number ⏏
Using a GEOSPreparedGeometry do a high performance calculation of whether the provided geometry crosses.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedCrosses_r ⇒ number ⏏
Using a GEOSPreparedGeometry do a high performance calculation of whether the provided geometry crosses.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedDisjoint ⇒ number ⏏
Use a GEOSPreparedGeometry do a high performance calculation of whether the provided geometry is disjoint.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedDisjoint_r ⇒ number ⏏
Use a GEOSPreparedGeometry do a high performance calculation of whether the provided geometry is disjoint.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedDistance ⇒ number ⏏
Use a GEOSPreparedGeometry do a high performance calculation to find the distance between the prepared and provided geometry. Useful for situations where one geometry is large and static and needs to be tested against a large number of other geometries.
Kind: global property of geos
Returns: number - 1 on success
| Param | Type | Description |
|---|---|---|
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
| dist | NumberPointer | Pointer to store the result in |
geos.GEOSPreparedDistanceWithin ⇒ number ⏏
Use a GEOSPreparedGeometry do a high performance calculation to find whether the prepared and provided geometry are within the given max distance. Useful for situations where one geometry is large and static and needs to be tested against a large number of other geometries.
Kind: global property of geos
Returns: number - 1 on success
| Param | Type | Description |
|---|---|---|
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
| dist | number | The max distance |
geos.GEOSPreparedDistanceWithin_r ⇒ number ⏏
Use a GEOSPreparedGeometry do a high performance calculation to find whether the prepared and provided geometry are within the given max distance. Useful for situations where one geometry is large and static and needs to be tested against a large number of other geometries.
Kind: global property of geos
Returns: number - 1 on success
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
| dist | number | The max distance |
geos.GEOSPreparedDistance_r ⇒ number ⏏
Use a GEOSPreparedGeometry do a high performance calculation to find the distance between the prepared and provided geometry. Useful for situations where one geometry is large and static and needs to be tested against a large number of other geometries.
Kind: global property of geos
Returns: number - 1 on success
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
| dist | NumberPointer | Pointer to store the result in |
geos.GEOSPreparedGeom_destroy ⇒ null ⏏
Free the memory associated with a GEOSPreparedGeometry. Caller must separately free the base GEOSGeometry used to create the prepared geometry.
Kind: global property of geos
Returns: null - void
| Param | Type | Description |
|---|---|---|
| g | GEOSPreparedGeometry | Prepared geometry to destroy. |
geos.GEOSPreparedGeom_destroy_r ⇒ null ⏏
Free the memory associated with a GEOSPreparedGeometry. Caller must separately free the base GEOSGeometry used to create the prepared geometry.
Kind: global property of geos
Returns: null - void
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSPreparedGeometry | Prepared geometry to destroy. |
geos.GEOSPreparedIntersects ⇒ number ⏏
Use a GEOSPreparedGeometry do a high performance calculation of whether the provided geometry intersects.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedIntersectsXY ⇒ number ⏏
Use a GEOSPreparedGeometry do a high performance calculation of whether the provided point intersects.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| x | number | x coordinate of point to test |
| y | number | y coordinate of point to test |
geos.GEOSPreparedIntersectsXY_r ⇒ number ⏏
Use a GEOSPreparedGeometry do a high performance calculation of whether the provided point intersects.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| x | number | x coordinate of point to test |
| y | number | y coordinate of point to test |
geos.GEOSPreparedIntersects_r ⇒ number ⏏
Use a GEOSPreparedGeometry do a high performance calculation of whether the provided geometry intersects.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedNearestPoints ⇒ GEOSCoordSequence ⏏
Use a GEOSPreparedGeometry do a high performance calculation to find the nearest points between the prepared and provided geometry.
Kind: global property of geos
Returns: GEOSCoordSequence - A coordinate sequence containing the nearest points, or NULL on exception. The first point in the sequence is from the prepared geometry, and the seconds is from the other argument.
| Param | Type | Description |
|---|---|---|
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedNearestPoints_r ⇒ GEOSCoordSequence ⏏
Use a GEOSPreparedGeometry do a high performance calculation to find the nearest points between the prepared and provided geometry.
Kind: global property of geos
Returns: GEOSCoordSequence - A coordinate sequence containing the nearest points, or NULL on exception. The first point in the sequence is from the prepared geometry, and the seconds is from the other argument.
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedOverlaps ⇒ number ⏏
Use a GEOSPreparedGeometry do a high performance calculation of whether the provided geometry overlaps.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedOverlaps_r ⇒ number ⏏
Use a GEOSPreparedGeometry do a high performance calculation of whether the provided geometry overlaps.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedRelate ⇒ StringPointer ⏏
Use a GEOSPreparedGeometry do a high-performance calculation of the DE9IM relationship between the prepared and provided geometry.
Kind: global property of geos
Returns: StringPointer - The DE9IM string
| Param | Type | Description |
|---|---|---|
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedRelatePattern ⇒ number ⏏
Use a GEOSPreparedGeometry do a high-performance calculation of the DE9IM relationship between the prepared and provided geometry, and compare the relationship to the provided DE9IM pattern. Returns true if the patterns are consistent and false otherwise.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
| imPattern | StringPointer | The DE9IM pattern to test |
geos.GEOSPreparedRelatePattern_r ⇒ number ⏏
Use a GEOSPreparedGeometry do a high-performance calculation of the DE9IM relationship between the prepared and provided geometry, and compare the relationship to the provided DE9IM pattern. Returns true if the patterns are consistent and false otherwise.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
| im | StringPointer | The DE9IM pattern to test |
geos.GEOSPreparedRelate_r ⇒ StringPointer ⏏
Use a GEOSPreparedGeometry do a high-performance calculation of the DE9IM relationship between the prepared and provided geometry.
Kind: global property of geos
Returns: StringPointer - The DE9IM string
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedTouches ⇒ number ⏏
Use a GEOSPreparedGeometry do a high performance calculation of whether the provided geometry touches.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedTouches_r ⇒ number ⏏
Use a GEOSPreparedGeometry do a high performance calculation of whether the provided geometry touches.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedWithin ⇒ number ⏏
Use a GEOSPreparedGeometry do a high performance calculation of whether the provided geometry is within.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |
geos.GEOSPreparedWithin_r ⇒ number ⏏
Use a GEOSPreparedGeometry do a high performance calculation of whether the provided geometry is within.
Kind: global property of geos
Returns: number - 1 on true, 0 on false, 2 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| pg1 | GEOSPreparedGeometry | The prepared geometry |
| g2 | GEOSGeometry | The geometry to test |