| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Data.Geometry.Geos.Prepared
Description
An interface for classes which prepare Geometrys in order to optimize the performance of repeated calls to specific geometric operations.
A given implementation may provide optimized implementations for only some of the specified methods, and delegate the remaining methods to the original Geometry operations. An implementation may also only optimize certain situations, and delegate others. See the implementing classes for documentation about which methods and situations they optimize.
Synopsis
- prepare :: Geometry a -> PreparedGeometry
- contains :: Relatable a => a -> Geometry b -> Bool
- containsProperly :: PreparedGeometry -> Geometry a -> Bool
- coveredBy :: Relatable a => a -> Geometry b -> Bool
- covers :: Relatable a => a -> Geometry b -> Bool
- crosses :: Relatable a => a -> Geometry b -> Bool
- disjoint :: Relatable a => a -> Geometry b -> Bool
- intersects :: Relatable a => a -> Geometry b -> Bool
- overlaps :: Relatable a => a -> Geometry b -> Bool
- touches :: Relatable a => a -> Geometry b -> Bool
- within :: Relatable a => a -> Geometry b -> Bool
Documentation
containsProperly :: PreparedGeometry -> Geometry a -> Bool Source #
The containsProperly predicate has the following equivalent definitions:
Every point of the other geometry is a point of this geometry's interior. In other words, if the test geometry has any interaction with the boundary of the target geometry the result of containsProperly is false. This is different semantics to the contains predicate, in which test geometries can intersect the target's boundary and still be contained.
The advantage of using this predicate is that it can be computed efficiently, since it avoids the need to compute the full topological relationship of the input boundaries in cases where they intersect.
An example use case is computing the intersections of a set of geometries with a large polygonal geometry. Since intersection is a fairly slow operation, it can be more efficient to use containsProperly to filter out test geometries which lie wholly inside the area. In these cases the intersection is known a priori to be exactly the original test geometry.