Yi.Region

This module defines the Region ADT

Documentation

data Region

The region data type. The region is semi open: it includes the start but not the end bound. This allows simpler region-manipulation algorithms. Invariant : regionStart r <= regionEnd r

Instances

Show Region

Typeable Region

Arbitrary Region

Binary Region

emptyRegion :: Region

The empty region

regionIsEmpty :: Region -> Bool

mkRegion :: Point -> Point -> Region

Construct a region from its bounds, emacs style: the right bound is excluded

mkRegion' :: Direction -> Point -> Point -> Region

mkSizeRegion :: Point -> Size -> Region

regionStart :: Region -> Point

regionEnd :: Region -> Point

regionSize :: Region -> Size

regionDirection :: Region -> Direction

inRegion :: Point -> Region -> Bool

True if the given point is inside the given region.

nearRegion :: Point -> Region -> Bool

True if the given point is inside the given region or at the end of it.

includedRegion :: Region -> Region -> Bool

Returns if a region (1st arg) is included in another (2nd arg)

fmapRegion :: (Point -> Point) -> Region -> Region

intersectRegion :: Region -> Region -> Region

Take the intersection of two regions

unionRegion :: Region -> Region -> Region

Take the union of two regions (including what is between them)

regionFirst :: Region -> Point

regionLast :: Region -> Point

regionsOverlap :: Bool -> Region -> Region -> Bool