Brick.BorderMap · brick-2.10 · horizon-platform

datadata BorderMap a

A BorderMap a is like a Map Location a, except that there is a rectangle, and only Locations on the border of this rectangle are retained. The BorderMap can be queried for the position and size of the rectangle. There are also efficient bulk query and bulk update operations for adjacent positions on the border.

Instances8Functor, Eq, Ord, Read, Show, Generic, …

Functor BorderMapDefined in brick-2.10 · Brick.BorderMap
Eq a => Eq (BorderMap a)Defined in brick-2.10 · Brick.BorderMap
Ord a => Ord (BorderMap a)Defined in brick-2.10 · Brick.BorderMap
Read a => Read (BorderMap a)Defined in brick-2.10 · Brick.BorderMap
Show a => Show (BorderMap a)Defined in brick-2.10 · Brick.BorderMap
Generic (BorderMap a)Defined in brick-2.10 · Brick.BorderMap
NFData a => NFData (BorderMap a)Defined in brick-2.10 · Brick.BorderMap
type Rep (BorderMap a) = D1 ('MetaData "BorderMap" "Brick.BorderMap" "brick-2.10-EjbKtbggBIDAB27Nb1O2P0" 'False) (C1 ('MetaCons "BorderMap" 'PrefixI 'True) (S1 ('MetaSel ('Just "_coordinates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Edges Int)) :*: S1 ('MetaSel ('Just "_values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Edges (IMap a)))))Defined in brick-2.10 · Brick.BorderMap

datadata Edges a

#

Constructors

Edges
- eTop :: a
- eBottom :: a
- eLeft :: a
- eRight :: a

Instances10Monad, Functor, Applicative, Eq, Ord, Read, …

Monad EdgesDefined in brick-2.10 · Brick.Types.Common
Functor EdgesDefined in brick-2.10 · Brick.Types.Common
Applicative EdgesDefined in brick-2.10 · Brick.Types.Common
Eq a => Eq (Edges a)Defined in brick-2.10 · Brick.Types.Common
Ord a => Ord (Edges a)Defined in brick-2.10 · Brick.Types.Common
Read a => Read (Edges a)Defined in brick-2.10 · Brick.Types.Common
Show a => Show (Edges a)Defined in brick-2.10 · Brick.Types.Common
Generic (Edges a)Defined in brick-2.10 · Brick.Types.Common
NFData a => NFData (Edges a)Defined in brick-2.10 · Brick.Types.Common
type Rep (Edges a) = D1 ('MetaData "Edges" "Brick.Types.Common" "brick-2.10-EjbKtbggBIDAB27Nb1O2P0" 'False) (C1 ('MetaCons "Edges" 'PrefixI 'True) ((S1 ('MetaSel ('Just "eTop") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Just "eBottom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)) :*: (S1 ('MetaSel ('Just "eLeft") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Just "eRight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a))))Defined in brick-2.10 · Brick.Types.Common

valueeTopL :: Functor f => (a -> f a) -> Edges a -> f (Edges a)

#

valueeBottomL :: Functor f => (a -> f a) -> Edges a -> f (Edges a)

#

valueeRightL :: Functor f => (a -> f a) -> Edges a -> f (Edges a)

#

valueeLeftL :: Functor f => (a -> f a) -> Edges a -> f (Edges a)

#

valueempty :: BorderMap a

#

An empty BorderMap that does not track any points.

valueclear :: BorderMap a -> BorderMap b

#

An empty BorderMap that tracks the same points as the input.

valueemptyCoordinates :: Edges Int -> BorderMap a

#

Given a rectangle (specified as the coordinates of the top, left, bottom, and right sides), initialize an empty BorderMap.

valuesingleton :: Location -> a -> BorderMap a

#

A BorderMap that tracks only the given the point (and initially maps it to the given value).

valueinsertH :: Location -> Run a -> BorderMap a -> BorderMap a

#

Bulk insertion of horizontally-adjacent values. The Location gives the start point, and the Run extends in the "larger columns" direction.

valueinsertV :: Location -> Run a -> BorderMap a -> BorderMap a

#

Bulk insertion of vertically-adjacent values. The Location gives the start point, and the Run extends in the "larger rows" direction.

valueinsert :: Location -> a -> BorderMap a -> BorderMap a

#

Insert a single value at the given location.

valueunsafeUnion :: BorderMap a -> BorderMap a -> BorderMap a

#

Assumes the two BorderMaps are tracking the same rectangles, but have disjoint keys. This property is not checked.

valuecoordinates :: BorderMap a -> Edges Int

#

The positions of the edges of the rectangle whose border is retained in a BorderMap. For example, if coordinates m = e, then the top border contains the Locations on row eTop e and between columns eLeft e to eRight e inclusive.

valuebounds :: BorderMap a -> Edges (Int, Int)

#

A complementary way to query the edges of the rectangle whose border is retained in a BorderMap. For example, if bounds m = b, then a Location's column must be between fst (eTop b) and snd (eTop b) to be retained. See also coordinates, which is in most cases a more natural border query.

valuevalues :: BorderMap a -> Edges (IMap a)

#

Maps giving the values along each edge. Corner values are replicated in all relevant edges.

valuelookupRow :: Int -> BorderMap a -> IMap a

#

Look up all values on a given row. The IMap returned maps columns to values.

valuelookupCol :: Int -> BorderMap a -> IMap a

#

Look up all values on a given column. The IMap returned maps rows to values.

valuelookupH :: Location -> Run ignored -> BorderMap a -> IMap a

#

Bulk lookup of horizontally-adjacent values. The Location gives the starting point, and the Run extends in the "larger columns" direction. The IMap returned maps columns to values.

valuelookupV :: Location -> Run ignored -> BorderMap a -> IMap a

#

Bulk lookup of vertically-adjacent values. The Location gives the starting point, and the Run extends in the "larger rows" direction. The IMap returned maps rows to values.