Interactive.Plot.Core

Core rendering functionality for the library.

Documentation

data Coord a

An ordered pair in a.

Constructors

C

Fields

• _cX :: a

  Access x.

• _cY :: a

  Access y.

Instances

Monad Coord

Basically the same as Reader Bool, for x and y.

Defined in Interactive.Plot.Core

Methods

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

(>>) :: Coord a -> Coord b -> Coord b

return :: a -> Coord a

fail :: String -> Coord a

Functor Coord

Defined in Interactive.Plot.Core

Methods

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

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

Applicative Coord

Defined in Interactive.Plot.Core

Methods

pure :: a -> Coord a

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

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

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

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

Foldable Coord

Defined in Interactive.Plot.Core

Methods

fold :: Monoid m => Coord m -> m

foldMap :: Monoid m => (a -> m) -> Coord a -> m

foldr :: (a -> b -> b) -> b -> Coord a -> b

foldr' :: (a -> b -> b) -> b -> Coord a -> b

foldl :: (b -> a -> b) -> b -> Coord a -> b

foldl' :: (b -> a -> b) -> b -> Coord a -> b

foldr1 :: (a -> a -> a) -> Coord a -> a

foldl1 :: (a -> a -> a) -> Coord a -> a

toList :: Coord a -> [a]

null :: Coord a -> Bool

length :: Coord a -> Int

elem :: Eq a => a -> Coord a -> Bool

maximum :: Ord a => Coord a -> a

minimum :: Ord a => Coord a -> a

sum :: Num a => Coord a -> a

product :: Num a => Coord a -> a

Traversable Coord

Defined in Interactive.Plot.Core

Methods

traverse :: Applicative f => (a -> f b) -> Coord a -> f (Coord b)

sequenceA :: Applicative f => Coord (f a) -> f (Coord a)

mapM :: Monad m => (a -> m b) -> Coord a -> m (Coord b)

sequence :: Monad m => Coord (m a) -> m (Coord a)

Eq a => Eq (Coord a)

Defined in Interactive.Plot.Core

Methods

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

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

Num a => Num (Coord a)

Defined in Interactive.Plot.Core

Methods

(+) :: Coord a -> Coord a -> Coord a

(-) :: Coord a -> Coord a -> Coord a

(*) :: Coord a -> Coord a -> Coord a

negate :: Coord a -> Coord a

abs :: Coord a -> Coord a

signum :: Coord a -> Coord a

fromInteger :: Integer -> Coord a

Ord a => Ord (Coord a)

Defined in Interactive.Plot.Core

Methods

compare :: Coord a -> Coord a -> Ordering

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

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

(>) :: Coord a -> Coord a -> Bool

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

max :: Coord a -> Coord a -> Coord a

min :: Coord a -> Coord a -> Coord a

Show a => Show (Coord a)

Defined in Interactive.Plot.Core

Methods

showsPrec :: Int -> Coord a -> ShowS

show :: Coord a -> String

showList :: [Coord a] -> ShowS

cX :: Lens' (Coord a) a

Getter/setter lens to the x position in a Coord.

cY :: Lens' (Coord a) a

Getter/setter lens to the x position in a Coord.

data Range a

A specification for a range. Using R, contains the minimum and maximum. Using RAbout, contains the midpoint and size.

Constructors

R

Fields

• _rMin :: a

  Minimum of range.

• _rMax :: a

  Maximum of range.

Bundled Patterns

pattern RAbout :: Fractional a => a -> a -> Range a

An alternative "constructor" for R, which takes a midpoint and size instead of a min and max.

This comes with record fields, _rMid and _rSize'.

Instances

Monad Range

Basically the same as Reader Bool, for minimum and maximum fields.

Defined in Interactive.Plot.Core

Methods

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

(>>) :: Range a -> Range b -> Range b

return :: a -> Range a

fail :: String -> Range a

Functor Range

Defined in Interactive.Plot.Core

Methods

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

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

Applicative Range

Zipping behavior on minimum and maximum

Defined in Interactive.Plot.Core

Methods

pure :: a -> Range a

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

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

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

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

Foldable Range

Defined in Interactive.Plot.Core

Methods

fold :: Monoid m => Range m -> m

foldMap :: Monoid m => (a -> m) -> Range a -> m

foldr :: (a -> b -> b) -> b -> Range a -> b

foldr' :: (a -> b -> b) -> b -> Range a -> b

foldl :: (b -> a -> b) -> b -> Range a -> b

foldl' :: (b -> a -> b) -> b -> Range a -> b

foldr1 :: (a -> a -> a) -> Range a -> a

foldl1 :: (a -> a -> a) -> Range a -> a

toList :: Range a -> [a]

null :: Range a -> Bool

length :: Range a -> Int

elem :: Eq a => a -> Range a -> Bool

maximum :: Ord a => Range a -> a

minimum :: Ord a => Range a -> a

sum :: Num a => Range a -> a

product :: Num a => Range a -> a

Traversable Range

Defined in Interactive.Plot.Core

Methods

traverse :: Applicative f => (a -> f b) -> Range a -> f (Range b)

sequenceA :: Applicative f => Range (f a) -> f (Range a)

mapM :: Monad m => (a -> m b) -> Range a -> m (Range b)

sequence :: Monad m => Range (m a) -> m (Range a)

Show a => Show (Range a)

Defined in Interactive.Plot.Core

Methods

showsPrec :: Int -> Range a -> ShowS

show :: Range a -> String

showList :: [Range a] -> ShowS

_rMid :: Range a -> Fractional a -> a

_rSize' :: Range a -> Fractional a -> a

rMin :: Lens' (Range a) a

Getter/setter lens to the minimum value in a Range.

rMax :: Lens' (Range a) a

Getter/setter lens to the maximum value in a Range.

rSize :: Fractional a => Lens' (Range a) a

Lens into the size of a Range Modifying this size results in a scaling about the midpoint of the range.

view rSize (R 2 4)
-- 2
over rSize (* 2) (R 2 4)
-- R 1 5

rMid :: Fractional a => Lens' (Range a) a

Lens into the midpoint of a Range. Modifying this midpoint shifts the range to a new midpoint, preserving the size.

view rMid (R 2 4)
-- 3
over rMid (+ 3) (R 2 4)
-- R 5 7

_rSize :: Num a => Range a -> a

Gets the size of a Range.

A version of _rSize' that works for any instance of Num.

data Auto a

Used to specify fields in PointStyle and SeriesF: Use Auto for automatic inference, and Given to provide a specific value.

Its Semigroup instance keeps the last Given.

Constructors

Auto

Given a

Instances

Monad Auto

Defined in Interactive.Plot.Core

Methods

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

(>>) :: Auto a -> Auto b -> Auto b

return :: a -> Auto a

fail :: String -> Auto a

Functor Auto

Defined in Interactive.Plot.Core

Methods

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

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

Applicative Auto

Defined in Interactive.Plot.Core

Methods

pure :: a -> Auto a

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

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

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

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

MonadPlus Auto

Opposite behavior of Semigroup instance: like Maybes Alternative instance, or First.

Defined in Interactive.Plot.Core

Methods

mzero :: Auto a

mplus :: Auto a -> Auto a -> Auto a

Alternative Auto

Opposite behavior of Semigroup instance: like Maybes Alternative instance, or First.

Defined in Interactive.Plot.Core

Methods

empty :: Auto a

(<|>) :: Auto a -> Auto a -> Auto a

some :: Auto a -> Auto [a]

many :: Auto a -> Auto [a]

Eq a => Eq (Auto a)

Defined in Interactive.Plot.Core

Methods

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

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

Ord a => Ord (Auto a)

Defined in Interactive.Plot.Core

Methods

compare :: Auto a -> Auto a -> Ordering

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

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

(>) :: Auto a -> Auto a -> Bool

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

max :: Auto a -> Auto a -> Auto a

min :: Auto a -> Auto a -> Auto a

Show a => Show (Auto a)

Defined in Interactive.Plot.Core

Methods

showsPrec :: Int -> Auto a -> ShowS

show :: Auto a -> String

showList :: [Auto a] -> ShowS

Generic (Auto a)

Defined in Interactive.Plot.Core

Associated Types

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

Methods

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

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

Semigroup (Auto a)

Keeps the final Given: like Last

Defined in Interactive.Plot.Core

Methods

(<>) :: Auto a -> Auto a -> Auto a

sconcat :: NonEmpty (Auto a) -> Auto a

stimes :: Integral b => b -> Auto a -> Auto a

Monoid (Auto a)

Defined in Interactive.Plot.Core

Methods

mempty :: Auto a

mappend :: Auto a -> Auto a -> Auto a

mconcat :: [Auto a] -> Auto a

type Rep (Auto a)

Defined in Interactive.Plot.Core

type Rep (Auto a) = D1 (MetaData "Auto" "Interactive.Plot.Core" "interactive-plot-0.1.0.0-3hlWKkOzuXtEUcnz41zcbZ" False) (C1 (MetaCons "Auto" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Given" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)))

type PointStyle = PointStyleF Identity

Specification of a style for a point.

Construct this wiht the PointStyle pattern synonym.

pattern PointStyle :: Char -> Color -> PointStyle

Pattern synonym/constructor for PointStyle.

This comes with two record fields, _psMarker and _psColor.

_psMarker :: PointStyle -> Char

_psColor :: PointStyle -> Color

data PointStyleF f

A parameterized version of PointStyle to unify functions in Interactive.Plot.Series.

Mainly you will be using either PointStyle or AutoPointStyle.

Constructors

PointStyleF

Fields

• _psMarkerF :: f Char

  Marker character.

• _psColorF :: f Color

  Marker color.

Instances

(Eq (f Char), Eq (f Color)) => Eq (PointStyleF f)

Defined in Interactive.Plot.Core

Methods

(==) :: PointStyleF f -> PointStyleF f -> Bool

(/=) :: PointStyleF f -> PointStyleF f -> Bool

(Ord (f Char), Ord (f OrdColor), Functor f, Eq (f Color)) => Ord (PointStyleF f)

Defined in Interactive.Plot.Core

Methods

compare :: PointStyleF f -> PointStyleF f -> Ordering

(<) :: PointStyleF f -> PointStyleF f -> Bool

(<=) :: PointStyleF f -> PointStyleF f -> Bool

(>) :: PointStyleF f -> PointStyleF f -> Bool

(>=) :: PointStyleF f -> PointStyleF f -> Bool

max :: PointStyleF f -> PointStyleF f -> PointStyleF f

min :: PointStyleF f -> PointStyleF f -> PointStyleF f

(Show (f Char), Show (f Color)) => Show (PointStyleF f)

Defined in Interactive.Plot.Core

Methods

showsPrec :: Int -> PointStyleF f -> ShowS

show :: PointStyleF f -> String

showList :: [PointStyleF f] -> ShowS

Generic (PointStyleF f)

Defined in Interactive.Plot.Core

Associated Types

type Rep (PointStyleF f) :: Type -> Type

Methods

from :: PointStyleF f -> Rep (PointStyleF f) x

to :: Rep (PointStyleF f) x -> PointStyleF f

(Semigroup (f Char), Semigroup (f Color)) => Semigroup (PointStyleF f)

Defined in Interactive.Plot.Core

Methods

(<>) :: PointStyleF f -> PointStyleF f -> PointStyleF f

sconcat :: NonEmpty (PointStyleF f) -> PointStyleF f

stimes :: Integral b => b -> PointStyleF f -> PointStyleF f

(Monoid (f Char), Monoid (f Color)) => Monoid (PointStyleF f)

Defined in Interactive.Plot.Core

Methods

mempty :: PointStyleF f

mappend :: PointStyleF f -> PointStyleF f -> PointStyleF f

mconcat :: [PointStyleF f] -> PointStyleF f

type Rep (PointStyleF f)

Defined in Interactive.Plot.Core

type Rep (PointStyleF f) = D1 (MetaData "PointStyleF" "Interactive.Plot.Core" "interactive-plot-0.1.0.0-3hlWKkOzuXtEUcnz41zcbZ" False) (C1 (MetaCons "PointStyleF" PrefixI True) (S1 (MetaSel (Just "_psMarkerF") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (f Char)) :*: S1 (MetaSel (Just "_psColorF") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (f Color))))

type AutoPointStyle = PointStyleF Auto

A version of PointStyle where you can leave the marker or color blank, to be automatically inferred.

You can construct this with the PointStyleF constructor.

It has a very convenient Monoid instance: mempty gives a PointStyle where every field is Auto, and <> combines PointStyles field-by-field, keeping the last Given.

psMarker :: Lens' PointStyle Char

psColor :: Lens' PointStyle Color

type Series = SeriesF Identity

Data for a single series: contains the coordinate map with the point style for the series.

data SeriesF f

A parameterized version of SeriesF to unify functions in Interactive.Plot.Series.

Mainly you will be using either SeriesF or AutoSeries.

Constructors

Series

Fields

• _sItems :: Map Double (Set Double)

  A map of x positions to y points at that position

• _sStyle :: PointStyleF f

  The style of points. For SeriesF, this is PointStyle; for AutoSeries, this is AutoPointStyle.

Instances

(Show (f Char), Show (f Color)) => Show (SeriesF f)

Defined in Interactive.Plot.Core

Methods

showsPrec :: Int -> SeriesF f -> ShowS

show :: SeriesF f -> String

showList :: [SeriesF f] -> ShowS

type AutoSeries = SeriesF Auto

A version of SeriesF where you can leave the marker or color blank, to be automatically inferred.

sItems :: Lens' (SeriesF f) (Map Double (Set Double))

Getter/setter lens to the items field of a SeriesF

sStyle :: Lens' (SeriesF f) (PointStyleF f)

Getter/setter lens to the style field of a SeriesF

sStyle :: Lens SeriesF PointStyle
sStyle :: Lens AutoSeries AutoPointStyle

toCoordMap :: Eq a => Set (Coord a) -> Map a (Set a)

Turn a set of coordinates into a map of x's to the y's found in the set.

Note that this forms an isomorphism with fromCoordMap.

fromCoordMap :: Map a (Set a) -> Set (Coord a)

Convert a map of x's to y's into a set of x-y coordinates.

Note that this forms an isomorphism with toCoordMap.

data Alignment

Alignment specification.

Constructors

ALeft

ACenter

ARight

data PlotOpts

Options used for running the plot interactively in a terminal.

Constructors

PO

Fields

• _poTermRatio :: Double

  character width ratio of terminal (H/W). Default is 2.1.

• _poAspectRatio :: Maybe Double

  plot aspect ratio (H/W). Use Nothing for automatic. Default is Just 1.

• _poXRange :: Maybe (Range Double)

  X Range. Use Nothing for automatic. Default is Nothing.

• _poYRange :: Maybe (Range Double)

  Y Range. Use Nothing for automatic. Default is Nothing.

• _poAutoMethod :: Maybe StdGen

  How to fill in missing values when run using runPlotAuto. Nothing for IO, Just for deterministic seed. Ignored when using runPlot. Default is an arbitrarily selected seed.

• _poHelp :: Bool

  Whether or not to show help box initially. Box can always be toggled with ?. (Default is True)

• _poFramerate :: Maybe Double

  Updates per second; Nothing for no updates. Use poDelay to treat this as a microsecond delay instead. (default: Nothing)

• _poDescription :: Maybe Image

  Initial extra information in description box. Ignored if directly using runPlotDynamic. Default is Nothing

Instances

Default PlotOpts

Defined in Interactive.Plot.Core

Methods

def :: PlotOpts

poTermRatio :: Lens' PlotOpts Double

poAspectRatio :: Lens' PlotOpts (Maybe Double)

poXRange :: Lens' PlotOpts (Maybe (Range Double))

poYRange :: Lens' PlotOpts (Maybe (Range Double))

poRange :: Lens' PlotOpts (Maybe (Range Double), Maybe (Range Double))

Lens into a PlotOpts getting its range X and range Y settings.

poAutoMethod :: Lens' PlotOpts (Maybe StdGen)

poHelp :: Lens' PlotOpts Bool

poFramerate :: Lens' PlotOpts (Maybe Double)

poDelay :: Lens' PlotOpts (Maybe Int)

Lens into microsecond delay between frames, specified by a PlotOpts.

poDescription :: Lens' PlotOpts (Maybe Image)

defaultPlotOpts :: PlotOpts

Sensible defaults for most terminals.

renderPlot

Arguments

:: Coord (Range Int)

display region

-> Coord (Range Double)

plot axis range

-> [Series]

-> [Image]

Render serieses based on a display region and plot axis ranges.

Internal

plotRange

Arguments

:: PlotOpts

-> Coord (Range Int)

display region

-> [Series]

Points

-> Coord (Range Double)

actual plot axis range

Compute plot axis ranges based on a list of points and the size of the display region.

newtype OrdColor

Newtype wrapper providing an Ord instance for Color.

Constructors

OC

Fields

• getOC :: Color

Instances

Eq OrdColor

Defined in Interactive.Plot.Core

Methods

(==) :: OrdColor -> OrdColor -> Bool

(/=) :: OrdColor -> OrdColor -> Bool

Ord OrdColor

Defined in Interactive.Plot.Core

Methods

compare :: OrdColor -> OrdColor -> Ordering

(<) :: OrdColor -> OrdColor -> Bool

(<=) :: OrdColor -> OrdColor -> Bool

(>) :: OrdColor -> OrdColor -> Bool

(>=) :: OrdColor -> OrdColor -> Bool

max :: OrdColor -> OrdColor -> OrdColor

min :: OrdColor -> OrdColor -> OrdColor

renderPoint :: PointStyle -> Image

Render a single according to a PointStyle.

hzToDelay :: Lens' (Maybe Double) (Maybe Int)

Used for poDelay: a lens into a microsecond delay given a framerate. Should technically be an isomorphism, but this isn't supported by microlens.