System.Console.Ansigraph.Core

This module provides the core functionality of the ansigraph package: terminal-based graphing for vectors and matrices of real and complex numbers.

This is implemented via a Graphable type class.

Ansigraph is intended to be used in on of two ways:

• By importing System.Console.AnsiGraph. This provides all the functionality we typically use, including the FlexibleInstances extension which makes it easier to use graphing functions by allowing instances like 'Graphable [Double]'.
• By directly importing System.Console.AnsiGraph.Core, which does not activate FlexibleInstances but includes everything else provided by the other module. This just means you must use one of a handful of newtype wrappers, namely: Graph, PosGraph, CGraph, Mat, CMat. These wrappers are also available from the standard module.

Core Functionality

The Graphable class

class Graphable a where

Things that ansigraph knows how to render at the terminal are instances of this class.

Methods

graphWith :: AGSettings -> a -> IO ()

Instances

Graphable CMat

Graphable Mat

Graphable PosGraph

Graphable CGraph

Graphable Graph

graph :: Graphable a => a -> IO ()

Invokes the Graphable type class method graphWith with the default AGSettings record, graphDefaults.

animateWith :: Graphable a => AGSettings -> [a] -> IO ()

Any list of a Graphable type can be made into an animation, by graphing each element with a time delay and screen-clear after each. AGSettings are used to determine the time delta and any coloring/scaling options.

animate :: Graphable a => [a] -> IO ()

Perform animateWith using default options. Equivalent to graphing each member of the supplied list with a short delay and screen-clear after each.

Graphing options

data AGSettings

Record that holds graphing options.

Constructors

AGSettings

Fields

realColor :: AnsiColor

Foreground color for real number component

imagColor :: AnsiColor

Foreground color for imaginary number component.

realBG :: AnsiColor

Background color for real number component.

imagBG :: AnsiColor

Background color for imaginary number component.

framerate :: Int

Framerate in fps.

scaling :: Int -> Int

How to rescale the size of a vector before displaying it (which is not implemented yet).

Default options

graphDefaults :: AGSettings

defaultScaling :: Int -> Int

Default scaling function.

blue :: AnsiColor

pink :: AnsiColor

white :: AnsiColor

ANSI data

data AnsiColor

ANSI colors are characterized by a Color and a ColorIntensity. This data type holds one of each.

Constructors

AnsiColor ColorIntensity Color

Instances

Show AnsiColor

data Coloring

Holds two AnsiColors representing foreground and background colors for display via ANSI.

Constructors

Coloring AnsiColor AnsiColor

Instances

Show Coloring

ANSI helpers

realColors :: AGSettings -> Coloring

Projection retrieving foreground and background colors for real number graphs in the form of a Coloring.

imagColors :: AGSettings -> Coloring

Projection retrieving foreground and background colors for imaginary component of complex number graphs in the form of a Coloring.

colorSets :: AGSettings -> (Coloring, Coloring)

Retrieves a pair of Colorings for real and imaginary graph components respectively.

invert :: Coloring -> Coloring

Swaps foreground and background colors within a Coloring.

setFG :: AnsiColor -> SGR

SGR command to set the foreground to the specified AnsiColor.

setBG :: AnsiColor -> SGR

SGR command to set the background to the specified AnsiColor.

lineClear :: IO ()

Clear any SGR color settings and then print a new line.

applyColor :: Coloring -> IO ()

Apply both foreground and background color.

withColoring :: Coloring -> IO () -> IO ()

Apply the supplied foreground and background coloring, then perform the supplied IO action, before reverting color settings and printing a new line.

Graphable wrapper types

newtype Graph

Wrapper type for graph of a real vector/function

Constructors

Graph

Fields

unGraph :: [Double]

Instances

Graphable Graph

newtype CGraph

Wrapper type for graph of a complex vector/function

Constructors

CGraph

Fields

unCGraph :: [Complex Double]

Instances

Graphable CGraph

newtype PosGraph

Wrapper type for graph of a non-negative real vector/function

Constructors

PosGraph

Fields

unPosGraph :: [Double]

Instances

Graphable PosGraph

newtype Mat

Wrapper type for graph of a real two-index vector/two-argument function

Constructors

Mat

Fields

unMat :: [[Double]]

Instances

Graphable Mat

newtype CMat

Wrapper type for graph of a complex two-index vector/two-argument function

Constructors

CMat

Fields

unCMat :: [[Complex Double]]

Instances

Graphable CMat

Graphing

Horizontal vector graphing

displayRV :: AGSettings -> [Double] -> IO ()

ANSI based display for real vectors. To be primarily invoked via graph, graphWith, animate, animateWith.

displayCV :: AGSettings -> [Complex Double] -> IO ()

ANSI based display for complex vectors. To be primarily invoked via graph, graphWith, animate, animateWith.

simpleRender :: [Double] -> String

Simple vector rendering. Yields a string of unicode chars representing graph bars varying in units of 1/8. To be primarily invoked via graph, graphWith, animate, animateWith.

simpleRenderR :: [Double] -> String

Simple vector rendering – inverted version. Rarely used directly. It is needed to render negative graph regions.

Matrix graphing

matShow :: [[Double]] -> [String]

Given a matrix of Doubles, return the list of strings illustrating the absolute value of each entry relative to the largest, via unicode chars that denote a particular density.

displayMat :: AGSettings -> [[Double]] -> IO ()

Use ANSI coloring (specified by an AGSettings) to visually display a Real matrix.

displayCMat :: AGSettings -> [[Complex Double]] -> IO ()

Use ANSI coloring (specified by an AGSettings) to visually display a Complex matrix.

Simple (non-ANSI) graphing for strictly-positive data

posgraph :: [Double] -> IO ()

Display a graph of the supplied (non-negative) real vector.

posanim :: [[Double]] -> IO ()

Display an animation of the supplied list of (non-negative) real vectors.