Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.Graph.Haggle.VertexLabelAdapter

Contents

Mutable Graph API
Immutable Graph API

Description

An adapter to create graphs with labeled vertices and unlabeled edges.

See LabeledGraph for an overview. The only significant difference is that this graph only supports adding unlabeled edges, and thus you must use addEdge instead of addLabeledEdge.

Synopsis

data VertexLabeledMGraph g nl m
data VertexLabeledGraph g nl
newVertexLabeledGraph :: (MGraph g, PrimMonad m, MonadRef m) => m (g m) -> m (VertexLabeledMGraph g nl m)
newSizedVertexLabeledGraph :: (MGraph g, PrimMonad m, MonadRef m) => (Int -> Int -> m (g m)) -> Int -> Int -> m (VertexLabeledMGraph g nl m)
mapVertexLabel :: VertexLabeledGraph g nl -> (nl -> nl') -> VertexLabeledGraph g nl'
fromEdgeList :: (MGraph g, MAddEdge g, MAddVertex g, Ord nl) => (forall s. ST s (g (ST s))) -> [(nl, nl)] -> (VertexLabeledGraph (ImmutableGraph g) nl, VertexMap nl)

Documentation

data VertexLabeledMGraph g nl m Source #

Instances

Instances details

MAddEdge g => MAddEdge (VertexLabeledMGraph g nl) Source #
Instance details Defined in Data.Graph.Haggle.VertexLabelAdapter Methods addEdge :: (PrimMonad m, MonadRef m) => VertexLabeledMGraph g nl m -> Vertex -> Vertex -> m (Maybe Edge) Source #
MBidirectional g => MBidirectional (VertexLabeledMGraph g nl) Source #
Instance details Defined in Data.Graph.Haggle.VertexLabelAdapter Methods getPredecessors :: (PrimMonad m, MonadRef m) => VertexLabeledMGraph g nl m -> Vertex -> m [Vertex] Source # getInEdges :: (PrimMonad m, MonadRef m) => VertexLabeledMGraph g nl m -> Vertex -> m [Edge] Source #
MGraph g => MGraph (VertexLabeledMGraph g nl) Source #
Instance details Defined in Data.Graph.Haggle.VertexLabelAdapter Associated Types type ImmutableGraph (VertexLabeledMGraph g nl) Source # Methods getVertices :: (PrimMonad m, MonadRef m) => VertexLabeledMGraph g nl m -> m [Vertex] Source # getSuccessors :: (PrimMonad m, MonadRef m) => VertexLabeledMGraph g nl m -> Vertex -> m [Vertex] Source # getOutEdges :: (PrimMonad m, MonadRef m) => VertexLabeledMGraph g nl m -> Vertex -> m [Edge] Source # countVertices :: (PrimMonad m, MonadRef m) => VertexLabeledMGraph g nl m -> m Int Source # countEdges :: (PrimMonad m, MonadRef m) => VertexLabeledMGraph g nl m -> m Int Source # checkEdgeExists :: (PrimMonad m, MonadRef m) => VertexLabeledMGraph g nl m -> Vertex -> Vertex -> m Bool Source # freeze :: (PrimMonad m, MonadRef m) => VertexLabeledMGraph g nl m -> m (ImmutableGraph (VertexLabeledMGraph g nl)) Source #
MAddVertex g => MLabeledVertex (VertexLabeledMGraph g nl) Source #
Instance details Defined in Data.Graph.Haggle.VertexLabelAdapter Associated Types type MVertexLabel (VertexLabeledMGraph g nl) Source # Methods getVertexLabel :: (PrimMonad m, MonadRef m) => VertexLabeledMGraph g nl m -> Vertex -> m (Maybe (MVertexLabel (VertexLabeledMGraph g nl))) Source # addLabeledVertex :: (PrimMonad m, MonadRef m) => VertexLabeledMGraph g nl m -> MVertexLabel (VertexLabeledMGraph g nl) -> m Vertex Source # getLabeledVertices :: (PrimMonad m, MonadRef m) => VertexLabeledMGraph g nl m -> m [(Vertex, MVertexLabel (VertexLabeledMGraph g nl))] Source #
type ImmutableGraph (VertexLabeledMGraph g nl) Source #
Instance details Defined in Data.Graph.Haggle.VertexLabelAdapter type ImmutableGraph (VertexLabeledMGraph g nl) = VertexLabeledGraph (ImmutableGraph g) nl
type MVertexLabel (VertexLabeledMGraph g nl) Source #
Instance details Defined in Data.Graph.Haggle.VertexLabelAdapter type MVertexLabel (VertexLabeledMGraph g nl) = nl

data VertexLabeledGraph g nl Source #

Instances

Instances details

(NFData g, NFData nl) => NFData (VertexLabeledGraph g nl) Source #
Instance details Defined in Data.Graph.Haggle.VertexLabelAdapter Methods rnf :: VertexLabeledGraph g nl -> () #
Bidirectional g => Bidirectional (VertexLabeledGraph g nl) Source #
Instance details Defined in Data.Graph.Haggle.VertexLabelAdapter Methods predecessors :: VertexLabeledGraph g nl -> Vertex -> [Vertex] Source # inEdges :: VertexLabeledGraph g nl -> Vertex -> [Edge] Source #
Graph g => Graph (VertexLabeledGraph g nl) Source #
Instance details Defined in Data.Graph.Haggle.VertexLabelAdapter Methods vertices :: VertexLabeledGraph g nl -> [Vertex] Source # edges :: VertexLabeledGraph g nl -> [Edge] Source # successors :: VertexLabeledGraph g nl -> Vertex -> [Vertex] Source # outEdges :: VertexLabeledGraph g nl -> Vertex -> [Edge] Source # maxVertexId :: VertexLabeledGraph g nl -> Int Source # isEmpty :: VertexLabeledGraph g nl -> Bool Source # edgesBetween :: VertexLabeledGraph g nl -> Vertex -> Vertex -> [Edge] Source #
Graph g => HasVertexLabel (VertexLabeledGraph g nl) Source #
Instance details Defined in Data.Graph.Haggle.VertexLabelAdapter Associated Types type VertexLabel (VertexLabeledGraph g nl) Source # Methods vertexLabel :: VertexLabeledGraph g nl -> Vertex -> Maybe (VertexLabel (VertexLabeledGraph g nl)) Source # labeledVertices :: VertexLabeledGraph g nl -> [(Vertex, VertexLabel (VertexLabeledGraph g nl))] Source #
Thawable g => Thawable (VertexLabeledGraph g nl) Source #
Instance details Defined in Data.Graph.Haggle.VertexLabelAdapter Associated Types type MutableGraph (VertexLabeledGraph g nl) :: (Type -> Type) -> Type Source # Methods thaw :: (PrimMonad m, MonadRef m) => VertexLabeledGraph g nl -> m (MutableGraph (VertexLabeledGraph g nl) m) Source #
type MutableGraph (VertexLabeledGraph g nl) Source #
Instance details Defined in Data.Graph.Haggle.VertexLabelAdapter type MutableGraph (VertexLabeledGraph g nl) = VertexLabeledMGraph (MutableGraph g) nl
type VertexLabel (VertexLabeledGraph g nl) Source #
Instance details Defined in Data.Graph.Haggle.VertexLabelAdapter type VertexLabel (VertexLabeledGraph g nl) = nl

Mutable Graph API

newVertexLabeledGraph :: (MGraph g, PrimMonad m, MonadRef m) => m (g m) -> m (VertexLabeledMGraph g nl m) Source #

newSizedVertexLabeledGraph :: (MGraph g, PrimMonad m, MonadRef m) => (Int -> Int -> m (g m)) -> Int -> Int -> m (VertexLabeledMGraph g nl m) Source #

Immutable Graph API

mapVertexLabel :: VertexLabeledGraph g nl -> (nl -> nl') -> VertexLabeledGraph g nl' Source #

fromEdgeList :: (MGraph g, MAddEdge g, MAddVertex g, Ord nl) => (forall s. ST s (g (ST s))) -> [(nl, nl)] -> (VertexLabeledGraph (ImmutableGraph g) nl, VertexMap nl) Source #

Build a new (immutable) graph from a list of edges. Edges are defined by pairs of node labels. A new Vertex will be allocated for each node label.

The type of the constructed graph is controlled by the first argument, which is a constructor for a mutable graph.

Example:

import Data.Graph.Haggle.VertexLabelAdapter
import Data.Graph.Haggle.SimpleBiDigraph

let (g,m) = fromEdgeList newMSimpleBiDigraph [(0,1), (1,2), (2,3), (3,0)]

g has type SimpleBiDigraph.

An alternative that is fully polymorphic in the return type would be possible, but it would require type annotations on the result of fromEdgeList, which could be very annoying.