Brick.BorderMap

Documentation

data 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.

Instances

Functor BorderMap

Defined in Brick.BorderMap

Methods

fmap :: (a -> b) -> BorderMap a -> BorderMap b

(<$) :: a -> BorderMap b -> BorderMap a

Generic (BorderMap a)

Defined in Brick.BorderMap

Associated Types

type Rep (BorderMap a) :: Type -> Type

Methods

from :: BorderMap a -> Rep (BorderMap a) x

to :: Rep (BorderMap a) x -> BorderMap a

Read a => Read (BorderMap a)

Defined in Brick.BorderMap

Methods

readsPrec :: Int -> ReadS (BorderMap a)

readList :: ReadS [BorderMap a]

readPrec :: ReadPrec (BorderMap a)

readListPrec :: ReadPrec [BorderMap a]

Show a => Show (BorderMap a)

Defined in Brick.BorderMap

Methods

showsPrec :: Int -> BorderMap a -> ShowS

show :: BorderMap a -> String

showList :: [BorderMap a] -> ShowS

NFData a => NFData (BorderMap a)

Defined in Brick.BorderMap

Methods

rnf :: BorderMap a -> ()

Eq a => Eq (BorderMap a)

Defined in Brick.BorderMap

Methods

(==) :: BorderMap a -> BorderMap a -> Bool

(/=) :: BorderMap a -> BorderMap a -> Bool

Ord a => Ord (BorderMap a)

Defined in Brick.BorderMap

Methods

compare :: BorderMap a -> BorderMap a -> Ordering

(<) :: BorderMap a -> BorderMap a -> Bool

(<=) :: BorderMap a -> BorderMap a -> Bool

(>) :: BorderMap a -> BorderMap a -> Bool

(>=) :: BorderMap a -> BorderMap a -> Bool

max :: BorderMap a -> BorderMap a -> BorderMap a

min :: BorderMap a -> BorderMap a -> BorderMap a

type Rep (BorderMap a)

Defined in Brick.BorderMap

type Rep (BorderMap a) = D1 ('MetaData "BorderMap" "Brick.BorderMap" "brick-2.3.1-inplace" '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)))))

data Edges a

Constructors

Edges

Fields

• eTop, eBottom, eLeft, eRight :: a

Instances

Applicative Edges

Defined in Brick.Types.Common

Methods

pure :: a -> Edges a

(<*>) :: Edges (a -> b) -> Edges a -> Edges b

liftA2 :: (a -> b -> c) -> Edges a -> Edges b -> Edges c

(*>) :: Edges a -> Edges b -> Edges b

(<*) :: Edges a -> Edges b -> Edges a

Functor Edges

Defined in Brick.Types.Common

Methods

fmap :: (a -> b) -> Edges a -> Edges b

(<$) :: a -> Edges b -> Edges a

Monad Edges

Defined in Brick.Types.Common

Methods

(>>=) :: Edges a -> (a -> Edges b) -> Edges b

(>>) :: Edges a -> Edges b -> Edges b

return :: a -> Edges a

Generic (Edges a)

Defined in Brick.Types.Common

Associated Types

type Rep (Edges a) :: Type -> Type

Methods

from :: Edges a -> Rep (Edges a) x

to :: Rep (Edges a) x -> Edges a

Read a => Read (Edges a)

Defined in Brick.Types.Common

Methods

readsPrec :: Int -> ReadS (Edges a)

readList :: ReadS [Edges a]

readPrec :: ReadPrec (Edges a)

readListPrec :: ReadPrec [Edges a]

Show a => Show (Edges a)

Defined in Brick.Types.Common

Methods

showsPrec :: Int -> Edges a -> ShowS

show :: Edges a -> String

showList :: [Edges a] -> ShowS

NFData a => NFData (Edges a)

Defined in Brick.Types.Common

Methods

rnf :: Edges a -> ()

Eq a => Eq (Edges a)

Defined in Brick.Types.Common

Methods

(==) :: Edges a -> Edges a -> Bool

(/=) :: Edges a -> Edges a -> Bool

Ord a => Ord (Edges a)

Defined in Brick.Types.Common

Methods

compare :: Edges a -> Edges a -> Ordering

(<) :: Edges a -> Edges a -> Bool

(<=) :: Edges a -> Edges a -> Bool

(>) :: Edges a -> Edges a -> Bool

(>=) :: Edges a -> Edges a -> Bool

max :: Edges a -> Edges a -> Edges a

min :: Edges a -> Edges a -> Edges a

type Rep (Edges a)

Defined in Brick.Types.Common

type Rep (Edges a) = D1 ('MetaData "Edges" "Brick.Types.Common" "brick-2.3.1-inplace" '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))))

eTopL :: forall a. Lens' (Edges a) a

eBottomL :: forall a. Lens' (Edges a) a

eRightL :: forall a. Lens' (Edges a) a

eLeftL :: forall a. Lens' (Edges a) a

empty :: BorderMap a

An empty BorderMap that does not track any points.

clear :: BorderMap a -> BorderMap b

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

emptyCoordinates :: Edges Int -> BorderMap a

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

singleton :: Location -> a -> BorderMap a

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

insertH :: 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.

insertV :: 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.

insert :: Location -> a -> BorderMap a -> BorderMap a

Insert a single value at the given location.

unsafeUnion :: BorderMap a -> BorderMap a -> BorderMap a

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

coordinates :: 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.

bounds :: 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.

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

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

lookupRow :: Int -> BorderMap a -> IMap a

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

lookupCol :: Int -> BorderMap a -> IMap a

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

lookupH :: 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.

lookupV :: 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.

lookup :: Location -> BorderMap a -> Maybe a

Look up a single position.

setCoordinates :: Edges Int -> BorderMap a -> BorderMap a

Set the rectangle being tracked by this BorderMap, throwing away any values that do not lie on this new rectangle.

crop :: Edges Int -> BorderMap a -> BorderMap a

Ensure that the rectangle being tracked by this BorderMap extends no farther than the given one.

expand :: Edges Int -> BorderMap a -> BorderMap a

Ensure that the rectangle being tracked by this BorderMap extends at least as far as the given one.

translate :: Location -> BorderMap a -> BorderMap a

Move a BorderMap by adding the given Location to all keys in the map.