Wumpus.Basic.Kernel.Base.BaseDefs

The elementary base types and classes.

Documentation

type family MonUnit m :: *

Type family to access the unit parameter of a TraceDrawing or a promoted TraceDrawingT transformer.

A semigroup class

class OPlus t where

A Semigroup class.

The perhaps unusual name is the TeX name for the circled plus glyph. It would be nice if there was a semigroup class in the Haskell Base libraries...

Methods

oplus :: t -> t -> t

Instances

OPlus ()

OPlus Primitive

OPlus CatPrim

OPlus CtxPicture

 a `oplus` b

Place 'drawing' a over b. The idea of over here is in terms z-ordering, nither picture a or b are actually moved.

Ord u => OPlus (BoundingBox u)

Num u => OPlus (Vec2 u)

OPlus (UNil u)

(Fractional u, Ord u) => OPlus (Orientation u)

OPlus a => OPlus (r -> a)

(OPlus a, OPlus b) => OPlus (a, b)

OPlus a => OPlus (Const a b)

(OPlus a, OPlus b, OPlus c) => OPlus (a, b, c)

(OPlus a, OPlus b, OPlus c, OPlus d) => OPlus (a, b, c, d)

oconcat :: OPlus t => t -> [t] -> t

oconcat : list_head * [rest] -> Ans

Semigroup version of mconcat from the module Data.Monoid.

As a semigroup cannot build a zero value, concat cannot handle the empty list. So to make oconcat a safe function the input list is already destructured by one cons cell.

Effectively this means that client code must handle the empty list case, before calling oconcat.

altconcat :: OPlus a => a -> [a] -> a

altconcat : alternative * [list] -> Ans

altconcat uses oplus to create a summary value from a list of values.

When supplied the empty list altconcat returns the supplied alternative value. If the list is inhabited, the alternative value is discarded.

This contrasts to oconcat where the single value represents the head of an already destructured list.

A bifunctor class

class Bimap f where

A Bifunctor class.

Again, it would be nice if there was a Bifunctor class in the Haskell Base libraries...

Methods

bimap :: (a -> p) -> (b -> q) -> f a b -> f p q

bimapL :: (a -> p) -> f a b -> f p b

bimapR :: (b -> q) -> f a b -> f a q

Instances

Bimap Either

Bimap (,)

replaceL :: Bimap f => p -> f a b -> f p b

replaceR :: Bimap f => q -> f a b -> f a q

Unit phantom type

data UNil u

The empty data type - i.e. () - wrapped with a phantom unit parameter.

Constructors

UNil

Instances

Functor UNil

Eq (UNil u)

Ord (UNil u)

Read (UNil u)

Show (UNil u)

Monoid (UNil u)

Rotate (UNil u)

RotateAbout (UNil u)

Scale (UNil u)

Translate (UNil u)

OPlus (UNil u)

Non-contextual unit conversion.

class ScalarUnit a where

Methods

fromPsPoint :: Double -> a

toPsPoint :: a -> Double

Instances

ScalarUnit Double

ScalarUnit Pica

ScalarUnit Centimeter

Unit interpretation with respect to the current Point size

class Num u => InterpretUnit u where

Methods

normalize :: FontSize -> u -> Double

dinterp :: FontSize -> Double -> u

Instances

InterpretUnit Double

InterpretUnit AfmUnit

InterpretUnit En

InterpretUnit Em

InterpretUnit Pica

InterpretUnit Centimeter

dinterpF :: (Functor t, InterpretUnit u) => FontSize -> t Double -> t u

dinterp an object that gives access to its unit at the functor position.

normalizeF :: (Functor t, InterpretUnit u) => FontSize -> t u -> t Double

normalize an object that gives access to its unit at the functor position.

uconvert1 :: (InterpretUnit u, InterpretUnit u1) => FontSize -> u -> u1

Convert a scalar value from one unit to another.

uconvertF :: (Functor t, InterpretUnit u, InterpretUnit u1) => FontSize -> t u -> t u1

Unit convert an object that gives access to its unit at the Functor position.

In practive this will be *all* Image answers.

intraMapPoint :: InterpretUnit u => FontSize -> (DPoint2 -> DPoint2) -> Point2 u -> Point2 u

intraMapFunctor :: (Functor f, InterpretUnit u) => FontSize -> (f Double -> f Double) -> f u -> f u

Drawing paths

data DrawStyle

Constructors

FILL

STROKE

FILL_STROKE

Instances

Bounded DrawStyle

Enum DrawStyle

Eq DrawStyle

Ord DrawStyle

Show DrawStyle

Drawing layer

data ZDeco

Decorating with resepct to the Z-order

 SUPERIOR - in front. 

 ANTERIOR - behind.

Constructors

SUPERIOR

ANTERIOR

Instances

Bounded ZDeco

Enum ZDeco

Eq ZDeco

Ord ZDeco

Show ZDeco

Alignment

data HAlign

Horizontal alignment - align to the top, center or bottom.

Constructors

HTop

HCenter

HBottom

Instances

Enum HAlign

Eq HAlign

Ord HAlign

Show HAlign

data VAlign

Vertical alignment - align to the left, center or bottom.

Constructors

VLeft

VCenter

VRight

Instances

Enum VAlign

Eq VAlign

Ord VAlign

Show VAlign

Cardinal (compass) positions

data Cardinal

An enumeratied type representing the compass positions.

Constructors

NORTH

NORTH_EAST

EAST

SOUTH_EAST

SOUTH

SOUTH_WEST

WEST

NORTH_WEST

Instances

Enum Cardinal

Eq Cardinal

Ord Cardinal

Show Cardinal

Direction enumeration

data Direction

An enumerated type representing horizontal and vertical directions.

Constructors

UP

DOWN

LEFT

RIGHT

Instances

Enum Direction

Eq Direction

Ord Direction

Show Direction

Misc (potentially for Wumpus-Core)

vsum :: Num u => [Vec2 u] -> Vec2 u

Sum a list of Vectors.

Note - this function is a candidate to go in Wumpus-Core, but it will be added when there is an intrinsic reason to to update Core (bug fix, or API change).