Math.Combinat.ASCII

A mini-DSL for ASCII drawing of structures.

From some structures there is also Graphviz and/or diagrams (http://projects.haskell.org/diagrams) visualization support (the latter in the separate libray combinat-diagrams).

The basic ASCII type

data ASCII

The type of a (rectangular) ASCII figure. Internally it is a list of lines of the same length plus the size.

Note: The Show instance is pretty-printing, so that it's convenient in ghci.

Constructors

ASCII

Fields

asciiSize :: (Int, Int)

asciiLines :: [String]

Instances

Show ASCII

class DrawASCII a where

A type class to have a simple way to draw things

Methods

ascii :: a -> ASCII

Instances

DrawASCII DisjointCycles

DrawASCII Permutation

DrawASCII Partition

DrawASCII SkewPartition

DrawASCII LatticePath

DrawASCII T

DrawASCII TDiag

DrawASCII (BinTree ())

Show a => DrawASCII (TriangularArray a)

KnownNat n => DrawASCII (Braid n)

Show a => DrawASCII (SkewTableau a)

emptyRect :: ASCII

An empty (0x0) rectangle

asciiXSize :: ASCII -> Int

asciiYSize :: ASCII -> Int

asciiString :: ASCII -> String

printASCII :: ASCII -> IO ()

asciiFromLines :: [String] -> ASCII

asciiFromString :: String -> ASCII

Alignment

data HAlign

Horizontal alignment

Constructors

HLeft

HCenter

HRight

Instances

Eq HAlign

Show HAlign

data VAlign

Vertical alignment

Constructors

VTop

VCenter

VBottom

Instances

Eq VAlign

Show VAlign

data Alignment

Constructors

Align HAlign VAlign

Separators

data HSep

Horizontal separator

Constructors

HSepEmpty

empty separator

HSepSpaces Int

n spaces

HSepString String

some custom string, eg. " | "

Instances

Show HSep

hSepSize :: HSep -> Int

hSepString :: HSep -> String

data VSep

Vertical separator

Constructors

VSepEmpty

empty separator

VSepSpaces Int

n spaces

VSepString [Char]

some custom list of characters, eg. " - " (the characters are interpreted as below each other)

Instances

Show VSep

vSepSize :: VSep -> Int

vSepString :: VSep -> [Char]

Concatenation

(|||) :: ASCII -> ASCII -> ASCII

Horizontal append, centrally aligned, no separation.

(===) :: ASCII -> ASCII -> ASCII

Vertical append, centrally aligned, no separation.

hCatTop :: [ASCII] -> ASCII

Horizontal concatenation, top-aligned, no separation

hCatBot :: [ASCII] -> ASCII

Horizontal concatenation, bottom-aligned, no separation

vCatLeft :: [ASCII] -> ASCII

Vertical concatenation, left-aligned, no separation

vCatRight :: [ASCII] -> ASCII

Vertical concatenation, right-aligned, no separation

hCatWith :: VAlign -> HSep -> [ASCII] -> ASCII

General horizontal concatenation

vCatWith :: HAlign -> VSep -> [ASCII] -> ASCII

General vertical concatenation

Padding

hPad :: Int -> ASCII -> ASCII

Horizontally pads with the given number of spaces, on both sides

vPad :: Int -> ASCII -> ASCII

Vertically pads with the given number of empty lines, on both sides

pad :: ASCII -> ASCII

Pads by single empty lines vertically and two spaces horizontally

Extension

hExtendTo :: HAlign -> Int -> ASCII -> ASCII

Extends an ASCII figure with spaces horizontally to the given width. Note: the alignment is the alignment of the original picture in the new bigger picture!

vExtendTo :: VAlign -> Int -> ASCII -> ASCII

Extends an ASCII figure with spaces vertically to the given height. Note: the alignment is the alignment of the original picture in the new bigger picture!

hExtendWith :: HAlign -> Int -> ASCII -> ASCII

Extend horizontally with the given number of spaces.

vExtendWith :: VAlign -> Int -> ASCII -> ASCII

Extend vertically with the given number of empty lines.

hIndent :: Int -> ASCII -> ASCII

Horizontal indentation

vIndent :: Int -> ASCII -> ASCII

Vertical indentation

Cutting

hCut :: HAlign -> Int -> ASCII -> ASCII

Cuts the given number of columns from the picture. The alignment is the alignment of the picture, not the cuts.

This should be the (left) inverse of hExtendWith.

vCut :: VAlign -> Int -> ASCII -> ASCII

Cuts the given number of rows from the picture. The alignment is the alignment of the picture, not the cuts.

This should be the (left) inverse of vExtendWith.

Pasting

pasteOnto :: (Int, Int) -> ASCII -> ASCII -> ASCII

Pastes the first ASCII graphics onto the second, keeping the second one's dimension (that is, overlapping parts of the first one are ignored). The offset is relative to the top-left corner of the second picture. Spaces at treated as transparent.

Example:

tabulate (HCenter,VCenter) (HSepSpaces 2, VSepSpaces 1)
 [ [ caption (show (x,y)) $
     pasteOnto (x,y) (filledBox '@' (4,3)) (asciiBox (7,5))
   | x <- [-4..7] ] 
 | y <- [-3..5] ]

pasteOnto'

Arguments

:: (Char -> Bool)

transparency condition

-> (Int, Int)

offset relative to the top-left corner of the second picture

-> ASCII

picture to paste

-> ASCII

picture to paste onto

-> ASCII

Pastes the first ASCII graphics onto the second, keeping the second one's dimension. The first argument specifies the transparency condition (on the first picture). The offset is relative to the top-left corner of the second picture.

pasteOntoRel :: (HAlign, VAlign) -> (Int, Int) -> ASCII -> ASCII -> ASCII

A version of pasteOnto where we can specify the corner of the second picture to which the offset is relative:

pasteOntoRel (HLeft,VTop) == pasteOnto

pasteOntoRel' :: (Char -> Bool) -> (HAlign, VAlign) -> (Int, Int) -> ASCII -> ASCII -> ASCII

Tabulate

tabulate :: (HAlign, VAlign) -> (HSep, VSep) -> [[ASCII]] -> ASCII

Tabulates the given matrix of pictures. Example:

tabulate (HCenter, VCenter) (HSepSpaces 2, VSepSpaces 1)
  [ [ asciiFromLines [ "x=" ++ show x , "y=" ++ show y ] | x<-[7..13] ] 
  | y<-[98..102] ]

data MatrixOrder

Order of elements in a matrix

Constructors

RowMajor

ColMajor

Instances

Eq MatrixOrder

Ord MatrixOrder

Read MatrixOrder

Show MatrixOrder

autoTabulate

Arguments

:: MatrixOrder

whether to use row-major or column-major ordering of the elements

-> Either Int Int

(Right x) creates x columns, while (Left y) creates y rows

-> [ASCII]

list of ASCII rectangles

-> ASCII

Automatically tabulates ASCII rectangles.

Captions

caption :: String -> ASCII -> ASCII

Adds a caption to the bottom, with default settings.

caption' :: Bool -> HAlign -> String -> ASCII -> ASCII

Adds a caption to the bottom. The Bool flag specifies whether to add an empty between the caption and the figure

Ready-made boxes

asciiBox :: (Int, Int) -> ASCII

An ASCII border box of the given size

roundedAsciiBox :: (Int, Int) -> ASCII

An "rounded" ASCII border box of the given size

filledBox :: Char -> (Int, Int) -> ASCII

A box simply filled with the given character

transparentBox :: (Int, Int) -> ASCII

A box of spaces

Testing / miscellanea

asciiNumber :: Int -> ASCII

An integer

asciiShow :: Show a => a -> ASCII