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


-- | A set of parsers for graph languages and conversions to
--   graph libaries.
--   
--   A package allowing parsing of graph files into graph library
--   datatypes. With aim the cope with large networks and provide
--   translations between graph libraries. Like a pandoc but for graphs.
--   This is my first library so any feedback and help is appreicated. For
--   example use please see the homepage.
@package pangraph
@version 0.1.2

module Pangraph

-- | The <a>Pangraph</a> type is the core intermediate type between
--   abstract representations of graphs.
data Pangraph

-- | Edges also reqiure [<a>Attribute</a>] and a tuple of <a>Vertex</a>
--   passed as connections to be constructed with <a>makeEdge</a>
data Edge

-- | A Vertex holds [<a>Attribute</a>] and must have a unique
--   <a>VertexID</a> to be constructed with <a>makeVertex</a>.
data Vertex

-- | The type alias for storage of fields.
type Attribute = (Key, Value)

-- | The <a>Key</a> in the tuple that makes up <a>Attribute</a>.
type Key = ByteString

-- | The <a>Value</a> in the tuple that makes up <a>Attribute</a>.
type Value = ByteString

-- | A field that is Maybe internally is exposed for lookup.
type VertexID = ByteString

-- | A type exposed for lookup in the resulting lists.
type EdgeID = Int

-- | Takes lists of <a>Vertex</a> and <a>Edge</a> to produce 'Just
--   Pangraph' if the graph is correctly formed.
makePangraph :: [Vertex] -> [Edge] -> Maybe Pangraph

-- | Edge constructor
makeEdge :: [Attribute] -> (Vertex, Vertex) -> Edge

-- | Vertex constructor
makeVertex :: VertexID -> [Attribute] -> Vertex

-- | Returns the [<a>Edge</a>] from a <a>Pangraph</a> instance
edgeList :: Pangraph -> [Edge]

-- | Returns the [<a>Vertex</a>] from a <a>Pangraph</a> instance
vertexList :: Pangraph -> [Vertex]

-- | Lookup of the <a>VertexID</a> in a <a>Pangraph</a>. Complexity:
--   <i>O(log n)</i>
lookupVertex :: VertexID -> Pangraph -> Maybe Vertex

-- | Lookup of the <a>EdgeID</a> in a <a>Pangraph</a>. Complexity: <i>O(log
--   n)</i>
lookupEdge :: EdgeID -> Pangraph -> Maybe Edge

-- | Returns the [<a>Attribute</a>] of an <a>Edge</a>
edgeAttributes :: Edge -> [Attribute]

-- | Returns the [<a>Attribute</a>] list of an <a>Edge</a>
vertexAttributes :: Vertex -> [Attribute]

-- | Returns the endpoint of tupled <a>Vertex</a> of an <a>Edge</a>
edgeEndpoints :: Edge -> (Vertex, Vertex)

-- | Returns the EdgeID if it has one. <a>Edge</a>s are given a new
--   <a>EdgeID</a> when they are passed and retrived from a <a>Pangraph</a>
edgeID :: Edge -> Maybe EdgeID

-- | Returns a <a>VertexID</a>
vertexID :: Vertex -> VertexID
instance GHC.Classes.Eq Pangraph.Pangraph
instance GHC.Classes.Eq Pangraph.Edge
instance GHC.Classes.Eq Pangraph.Vertex
instance GHC.Show.Show Pangraph.Pangraph
instance Algebra.Graph.Class.ToGraph Pangraph.Pangraph
instance GHC.Show.Show Pangraph.Edge
instance GHC.Show.Show Pangraph.Vertex

module Pangraph.Containers

-- | Transforms a <a>Pangraph</a> in a <a>Graph</a>.
convert :: Pangraph -> (Graph, Vertex -> (Vertex, VertexID, [VertexID]), VertexID -> Maybe Vertex)

module Pangraph.Examples.SampleGraph
smallGraph :: Pangraph

module Pangraph.Examples.ToContainersGraph
main :: IO ()

module Pangraph.GraphML.Writer

-- | Serialise a <a>Pangraph</a> into a GraphML file producing a
--   <a>ByteString</a>.
write :: Pangraph -> ByteString

module Pangraph.Examples.Writing
main :: IO ()

module Pangraph.Internal.XMLTemplate
data Template
graphMLTemplate :: Template
hexmlToPangraph :: Template -> HexmlVertex -> Maybe Pangraph

module Pangraph.GraphML.Parser

-- | Returns <tt>Pangraph</tt> if it can be parsed from a raw GraphML file.
parse :: ByteString -> Maybe Pangraph

-- | Like <a>parse</a> except it throws an error on Nothing, which is when
--   parsing fails.
unsafeParse :: ByteString -> Pangraph

module Pangraph.Examples.Reading
main :: IO ()