-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | 2D and 3D plots using gnuplot
--   
--   This is a wrapper to gnuplot which lets you create 2D and 3D plots.
--   
--   Start a simple session with <tt>make ghci</tt>. This loads the module
--   <a>Graphics.Gnuplot.Simple</a> which is ready for use in GHCi. It does
--   not address all fancy gnuplot features in order to stay simple. For
--   more sophisticated plots, especially batch generated graphics, I
--   recommend <a>Graphics.Gnuplot.Advanced</a>.
--   
--   With the Cabal flags executePipe and executeShell you can switch to
--   more convenient but probably less portable ways of running gnuplot.
--   
--   In the past this was part of the htam package.
@package gnuplot
@version 0.3.3.1

module Graphics.Gnuplot.Frame.Option
newtype T
Cons :: String -> T
newtype T
Cons :: String -> T
custom :: String -> T
title :: T
grid :: T
size :: T
key :: T
border :: T
pm3d :: T
xRange :: T
yRange :: T
zRange :: T
xLabel :: T
yLabel :: T
zLabel :: T
xTicks :: T
yTicks :: T
zTicks :: T

module Graphics.Gnuplot.Time

-- | Use it this way:
--   
--   <pre>
--   import Data.Time
--   import Graphics.Gnuplot.Simple
--   
--   main =
--      plotPath [XTime, XFormat "%m-%d"] $ prepXTime $
--         (UTCTime (fromGregorian 2008 01 01)     0, 1.0) :
--         (UTCTime (fromGregorian 2008 01 05) 43200, 5.0) :
--         (UTCTime (fromGregorian 2008 01 15)     0, 2.5) :
--         []
--   </pre>
prepXTime :: (FormatTime a, Read b) => [(a, b)] -> [(b, b)]


-- | Modularized interface to gnuplot that allows complex graphics and fine
--   control of their components. It is designed for non-interactive use,
--   e.g. scripts for plotting statistics.
--   
--   The hierarchy of objects is as follows:
--   
--   <ul>
--   <li><tt>Graph2D</tt>: A curve like a sine curve. Attributes of a graph
--   are line type, thickness, color.</li>
--   <li><tt>Graph3D</tt>: A surface.</li>
--   <li><tt>Plot</tt>: An overlay of many curves. It is parametrized by
--   the graph type (2D or 3D) in order to make sure, that only graphs of
--   one type are overlayed and only according attributes can be accessed.
--   You cannot generate plots or graphs alone, you can only generate plots
--   containing graphs using the functions in
--   <a>Graphics.Gnuplot.Plot.TwoDimensional</a> and
--   <a>Graphics.Gnuplot.Plot.ThreeDimensional</a>. You can combine plots
--   using the <a>Monoid</a> type class.</li>
--   <li><tt>Frame</tt>: Add options to a plot such as border, legend,
--   title, label attributes. See <a>Graphics.Gnuplot.Frame</a>.</li>
--   <li><tt>MultiPlot</tt>: Arrange several frames in a matrix layout. See
--   <a>Graphics.Gnuplot.MultiPlot</a>.</li>
--   </ul>
module Graphics.Gnuplot.Advanced

-- | The plot function returns <a>ExitCode</a>, which is nice for
--   programming but ugly for interactive GHCi sessions. For interactive
--   sessions, better use <a>Graphics.Gnuplot.Simple</a>. <tt>gfx</tt> must
--   be one of the types <tt>Plot</tt>, <tt>Frame</tt>, <tt>MultiPlot</tt>.
plot :: (C terminal, C gfx) => terminal -> gfx -> IO ExitCode

module Graphics.Gnuplot.Terminal.PostScript
data T
cons :: FilePath -> T
landscape :: T -> T
portrait :: T -> T
eps :: T -> T
color :: T -> T
monochrome :: T -> T
instance C T

module Graphics.Gnuplot.Terminal.PNG
data T
cons :: FilePath -> T
transparent :: T -> T
noTransparent :: T -> T
interlace :: T -> T
noInterlace :: T -> T
trueColor :: T -> T
noTrueColor :: T -> T
fontTiny :: T -> T
fontSmall :: T -> T
fontMedium :: T -> T
fontLarge :: T -> T
fontGiant :: T -> T
instance C T

module Graphics.Gnuplot.Terminal.SVG
data T
cons :: FilePath -> T
instance C T

module Graphics.Gnuplot.Terminal.X11
data T
cons :: T
title :: String -> T -> T
noTitle :: T -> T
persist :: T -> T
noPersist :: T -> T
instance C T

module Graphics.Gnuplot.Frame
data T graph
cons :: T graph -> T graph -> T graph
simple :: T graph -> T graph
empty :: T T

module Graphics.Gnuplot.MultiPlot
data T
data Part
partFromFrame :: (C graph) => T graph -> Part
partFromPlot :: (C graph) => T graph -> Part
simpleFromFrameArray :: (C graph, Ix i, Ix j) => Array (i, j) (T graph) -> T
simpleFromPartArray :: (Ix i, Ix j) => Array (i, j) Part -> T
instance C T

module Graphics.Gnuplot.Graph.TwoDimensional
data T
type Type = T
defaultType :: Type
deflt :: Column -> T
typ :: Type -> T -> T
lineSpec :: T -> T -> T
lines :: T
points :: T
linesPoints :: T
impulses :: T
dots :: T
steps :: T
fSteps :: T
hiSteps :: T
errorBars :: T
xErrorBars :: T
yErrorBars :: T
xyErrorBars :: T
errorLines :: T
xErrorLines :: T
yErrorLines :: T
xyErrorLines :: T
boxes :: T
filledCurves :: T
boxErrorBars :: T
boxXYErrorBars :: T
financeBars :: T
candleSticks :: T
vectors :: T

module Graphics.Gnuplot.Graph.ThreeDimensional
data T
type Type = T
defaultType :: Type
deflt :: Column -> T
typ :: Type -> T -> T
lineSpec :: T -> T -> T
lines :: T
points :: T
linesPoints :: T
impulses :: T
dots :: T
steps :: T
fSteps :: T
hiSteps :: T
errorBars :: T
xErrorBars :: T
yErrorBars :: T
xyErrorBars :: T
errorLines :: T
xErrorLines :: T
yErrorLines :: T
xyErrorLines :: T
boxes :: T
filledCurves :: T
boxErrorBars :: T
boxXYErrorBars :: T
financeBars :: T
candleSticks :: T
vectors :: T
pm3d :: T

module Graphics.Gnuplot.Frame.OptionSet
data T graph

-- | The default options contain what we expect as default value in
--   gnuplot. We need an entry for every option that cannot be reset by
--   <tt>unset</tt>.
deflt :: T graph

-- | Add an option with arguments as plain strings. This is very flexible,
--   but not very safe. Use it only as fall-back, if there is no specific
--   setter function in <a>Graphics.Gnuplot.Frame.OptionSet</a>.
add :: T -> [String] -> T graph -> T graph

-- | Remove an option.
remove :: T -> T graph -> T graph
size :: (C graph) => Double -> Double -> T graph -> T graph
title :: (C graph) => String -> T graph -> T graph
xRange :: (C graph) => (Double, Double) -> T graph -> T graph
yRange :: (C graph) => (Double, Double) -> T graph -> T graph
zRange :: (Double, Double) -> T T -> T T
xLabel :: (C graph) => String -> T graph -> T graph
yLabel :: (C graph) => String -> T graph -> T graph
zLabel :: String -> T T -> T T

module Graphics.Gnuplot.LineSpecification
data T
deflt :: T
lineStyle :: Int -> T -> T
lineType :: Int -> T -> T
lineWidth :: Double -> T -> T
pointType :: Int -> T -> T
pointSize :: Double -> T -> T
title :: String -> T -> T

module Graphics.Gnuplot.Plot.ThreeDimensional
linearScale :: (Fractional a) => Integer -> (a, a) -> [a]

-- | Plots can be assembled using <tt>mappend</tt> or <tt>mconcat</tt>.
type T = T T
mesh :: (Show a, Show b, Show c) => [[(a, b, c)]] -> T
function :: (Show a, Show b, Show c) => [b] -> [c] -> (b -> c -> a) -> T

module Graphics.Gnuplot.Plot.TwoDimensional
linearScale :: (Fractional a) => Integer -> (a, a) -> [a]

-- | Plots can be assembled using <tt>mappend</tt> or <tt>mconcat</tt>.
type T = T T

-- | <pre>
--   list (take 30 (let fibs = 0 : 1 : zipWith (+) fibs (tail fibs) in fibs))
--   </pre>
list :: (Show a) => [a] -> T

-- | <pre>
--   function (linearScale 1000 (-10,10)) sin
--   </pre>
function :: (Show a) => [a] -> (a -> a) -> T

-- | <pre>
--   functions (linearScale 1000 (-10,10)) [sin, cos]
--   </pre>
functions :: (Show a) => [a] -> [a -> a] -> T
path :: (Show a) => [(a, a)] -> T

-- | <pre>
--   parameterFunction (linearScale 1000 (0,2*pi)) (\t -&gt; (sin (2*t), cos t))
--   </pre>
parameterFunction :: (Show a) => [a] -> (a -> (a, a)) -> T
listFromFile :: FilePath -> Int -> T
pathFromFile :: FilePath -> Int -> Int -> T


-- | This is a simple monolithic interface to gnuplot that can be used as
--   is in GHCi or Hugs. We do not plan to support every feature of gnuplot
--   here, instead we provide an advanced modularized interface in
--   <a>Graphics.Gnuplot.Advanced</a>.
module Graphics.Gnuplot.Simple
data Attribute

-- | anything that is allowed after gnuplot's <tt>set</tt> command
Custom :: String -> [String] -> Attribute
EPS :: FilePath -> Attribute
PNG :: FilePath -> Attribute

-- | you cannot use this, call <a>terminal</a> instead
Terminal :: T -> Attribute
Grid :: (Maybe [String]) -> Attribute
Key :: (Maybe [String]) -> Attribute
Border :: (Maybe [String]) -> Attribute
XTicks :: (Maybe [String]) -> Attribute
YTicks :: (Maybe [String]) -> Attribute
Size :: (Size) -> Attribute
Aspect :: (Aspect) -> Attribute
BoxAspect :: (Aspect) -> Attribute
LineStyle :: Int -> [LineAttr] -> Attribute
Title :: String -> Attribute
XLabel :: String -> Attribute
YLabel :: String -> Attribute
XRange :: (Double, Double) -> Attribute
YRange :: (Double, Double) -> Attribute
ZRange :: (Double, Double) -> Attribute
Palette :: [(Double, (Double, Double, Double))] -> Attribute
ColorBox :: (Maybe [String]) -> Attribute
XTime :: Attribute
XFormat :: String -> Attribute
data Size
Scale :: Double -> Size
SepScale :: Double -> Double -> Size
data Aspect
Ratio :: Double -> Aspect
NoRatio :: Aspect
data LineAttr
LineType :: Int -> LineAttr
LineWidth :: Double -> LineAttr
PointType :: Int -> LineAttr
PointSize :: Double -> LineAttr
LineTitle :: String -> LineAttr
data LineSpec
DefaultStyle :: Int -> LineSpec
CustomStyle :: [LineAttr] -> LineSpec
data PlotType
Lines :: PlotType
Points :: PlotType
LinesPoints :: PlotType
Impulses :: PlotType
Dots :: PlotType
Steps :: PlotType
FSteps :: PlotType
HiSteps :: PlotType
ErrorBars :: PlotType
XErrorBars :: PlotType
YErrorBars :: PlotType
XYErrorBars :: PlotType
ErrorLines :: PlotType
XErrorLines :: PlotType
YErrorLines :: PlotType
XYErrorLines :: PlotType
Boxes :: PlotType
FilledCurves :: PlotType
BoxErrorBars :: PlotType
BoxXYErrorBars :: PlotType
FinanceBars :: PlotType
CandleSticks :: PlotType
Vectors :: PlotType
PM3d :: PlotType
data PlotStyle
PlotStyle :: PlotType -> LineSpec -> PlotStyle
plotType :: PlotStyle -> PlotType
lineSpec :: PlotStyle -> LineSpec
linearScale :: (Fractional a) => Integer -> (a, a) -> [a]
defaultStyle :: PlotStyle
terminal :: (C term) => term -> Attribute

-- | <pre>
--   plotList [] (take 30 (let fibs = 0 : 1 : zipWith (+) fibs (tail fibs) in fibs))
--   </pre>
plotList :: (Show a) => [Attribute] -> [a] -> IO ()
plotListStyle :: (Show a) => [Attribute] -> PlotStyle -> [a] -> IO ()
plotLists :: (Show a) => [Attribute] -> [[a]] -> IO ()
plotListsStyle :: (Show a) => [Attribute] -> [(PlotStyle, [a])] -> IO ()

-- | <pre>
--   plotFunc [] (linearScale 1000 (-10,10)) sin
--   </pre>
plotFunc :: (Show a) => [Attribute] -> [a] -> (a -> a) -> IO ()

-- | <pre>
--   plotFuncs [] (linearScale 1000 (-10,10)) [sin, cos]
--   </pre>
plotFuncs :: (Show a) => [Attribute] -> [a] -> [a -> a] -> IO ()
plotPath :: (Show a) => [Attribute] -> [(a, a)] -> IO ()
plotPaths :: (Show a) => [Attribute] -> [[(a, a)]] -> IO ()
plotPathStyle :: (Show a) => [Attribute] -> PlotStyle -> [(a, a)] -> IO ()
plotPathsStyle :: (Show a) => [Attribute] -> [(PlotStyle, [(a, a)])] -> IO ()

-- | <pre>
--   plotParamFunc [] (linearScale 1000 (0,2*pi)) (\t -&gt; (sin (2*t), cos t))
--   </pre>
plotParamFunc :: (Show a) => [Attribute] -> [a] -> (a -> (a, a)) -> IO ()

-- | <pre>
--   plotParamFuncs [] (linearScale 1000 (0,2*pi)) [\t -&gt; (sin (2*t), cos t), \t -&gt; (cos t, sin (2*t))]
--   </pre>
plotParamFuncs :: (Show a) => [Attribute] -> [a] -> [a -> (a, a)] -> IO ()
plotDots :: (Show a) => [Attribute] -> [(a, a)] -> IO ()
data Plot3dType
Surface :: Plot3dType
ColorMap :: Plot3dType
data CornersToColor
Mean :: CornersToColor
GeometricMean :: CornersToColor
Median :: CornersToColor
Corner1 :: CornersToColor
Corner2 :: CornersToColor
Corner3 :: CornersToColor
Corner4 :: CornersToColor
data Attribute3d
Plot3dType :: Plot3dType -> Attribute3d
CornersToColor :: CornersToColor -> Attribute3d

-- | <pre>
--   let xs = [-2,-1.8..2::Double] in plotMesh3d [] [] (do x &lt;- xs; return (do y &lt;- xs; return (x,y,cos(x*x+y*y))))
--   </pre>
plotMesh3d :: (Show a, Show b, Show c) => [Attribute] -> [Attribute3d] -> [[(a, b, c)]] -> IO ()

-- | <pre>
--   let xs = [-2,-1.8..2::Double] in plotFunc3d [] [] xs xs (\x y -&gt; exp(-(x*x+y*y)))
--   </pre>
plotFunc3d :: (Show a, Show b, Show c) => [Attribute] -> [Attribute3d] -> [b] -> [c] -> (b -> c -> a) -> IO ()

-- | Redirects the output of a plotting function to an EPS file and
--   additionally converts it to PDF.
epspdfPlot :: FilePath -> ([Attribute] -> IO ()) -> IO ()

-- | Creates an EPS and a PDF graphics and returns a string that can be
--   inserted into a LaTeX document to include this graphic.
--   
--   Different from GHCi, Hugs doesn't output a return value from an IO
--   monad. So you must wrap it with a <a>putStr</a>. Nevertheless this
--   implementation which returns the LaTeX command as string is the most
--   flexible one.
inclPlot :: FilePath -> ([Attribute] -> IO ()) -> IO String