Pangraph

Abstract Types

data Pangraph

The Pangraph type is the core intermediate type between abstract representations of graphs.

Instances

Eq Pangraph

Methods

(==) :: Pangraph -> Pangraph -> Bool

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

Show Pangraph

Methods

showsPrec :: Int -> Pangraph -> ShowS

show :: Pangraph -> String

showList :: [Pangraph] -> ShowS

ToGraph Pangraph

Associated Types

type ToVertex Pangraph :: *

Methods

toGraph :: (Graph g, (* ~ Vertex g) (ToVertex Pangraph)) => Pangraph -> g

type ToVertex Pangraph

type ToVertex Pangraph = Vertex

data Edge

Edges also reqiure [Attribute] and a tuple of Vertex passed as connections to be constructed with makeEdge

Instances

Eq Edge

Methods

(==) :: Edge -> Edge -> Bool

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

Show Edge

Methods

showsPrec :: Int -> Edge -> ShowS

show :: Edge -> String

showList :: [Edge] -> ShowS

data Vertex

A Vertex holds [Attribute] and must have a unique VertexID to be constructed with makeVertex.

Instances

Eq Vertex

Methods

(==) :: Vertex -> Vertex -> Bool

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

Show Vertex

Methods

showsPrec :: Int -> Vertex -> ShowS

show :: Vertex -> String

showList :: [Vertex] -> ShowS

type Attribute = (Key, Value)

The type alias for storage of fields.

type Key = ByteString

The Key in the tuple that makes up Attribute.

type Value = ByteString

The Value in the tuple that makes up Attribute.

type VertexID = ByteString

A field that is Maybe internally is exposed for lookup.

type EdgeID = Int

A type exposed for lookup in the resulting lists.

Constructors

makePangraph :: [Vertex] -> [Edge] -> Maybe Pangraph

Takes lists of Vertex and Edge to produce 'Just Pangraph' if the graph is correctly formed.

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

Edge constructor

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

Vertex constructor

Pangraph Getters

edgeList :: Pangraph -> [Edge]

Returns the [Edge] from a Pangraph instance

vertexList :: Pangraph -> [Vertex]

Returns the [Vertex] from a Pangraph instance

lookupVertex :: VertexID -> Pangraph -> Maybe Vertex

Lookup of the VertexID in a Pangraph. Complexity: O(log n)

lookupEdge :: EdgeID -> Pangraph -> Maybe Edge

Lookup of the EdgeID in a Pangraph. Complexity: O(log n)

Getters on Vertex and Edge

edgeAttributes :: Edge -> [Attribute]

Returns the [Attribute] of an Edge

vertexAttributes :: Vertex -> [Attribute]

Returns the [Attribute] list of an Edge

edgeEndpoints :: Edge -> (Vertex, Vertex)

Returns the endpoint of tupled Vertex of an Edge

edgeID :: Edge -> Maybe EdgeID

Returns the EdgeID if it has one. Edges are given a new EdgeID when they are passed and retrived from a Pangraph

vertexID :: Vertex -> VertexID

Returns a VertexID