Skip to content

HORIZON HASKELL Docs lts/ghc-9.10.x248f8f02026-10-05Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · 248f8f0 · 2026-10-05

Modulefgl-5.8.2.0Haskell98

Data.Graph.Inductive.NodeMap

Utility methods to automatically generate and keep track of a mapping between node labels and Nodes.

2 types
33 values

Packagefgl-5.8.2.0
Exports35
LanguageHaskell98
LicenceBSD-3-Clause
SourceNodeMap.hs

Functional Construction

1 declaration

datadata NodeMap a

Instances4Eq, Read, Show, NFData

Eq a => Eq (NodeMap a)Defined in fgl-5.8.2.0 · Data.Graph.Inductive.NodeMap
(Ord a, Read a) => Read (NodeMap a)Defined in fgl-5.8.2.0 · Data.Graph.Inductive.NodeMap
Show a => Show (NodeMap a)Defined in fgl-5.8.2.0 · Data.Graph.Inductive.NodeMap
NFData a => NFData (NodeMap a)Defined in fgl-5.8.2.0 · Data.Graph.Inductive.NodeMap

Map Construction

valuenew :: NodeMap a

Create a new, empty mapping.

valuefromGraph :: (Ord a, Graph g) => g a b -> NodeMap a

Generate a mapping containing the nodes in the given graph.

valuemkNode :: Ord a => NodeMap a -> a -> (LNode a, NodeMap a)

Generate a labelled node from the given label. Will return the same node for the same label.

valuemkNode_ :: Ord a => NodeMap a -> a -> LNode a

Generate a labelled node and throw away the modified NodeMap.

valuemkNodes :: Ord a => NodeMap a -> [a] -> ([LNode a], NodeMap a)

Construct a list of nodes.

valuemkNodes_ :: Ord a => NodeMap a -> [a] -> [LNode a]

Construct a list of nodes and throw away the modified NodeMap.

valuemkEdge :: Ord a => NodeMap a -> (a, a, b) -> Maybe (LEdge b)

Generate a LEdge from the node labels.

valuemkEdges :: Ord a => NodeMap a -> [(a, a, b)] -> Maybe [LEdge b]

Generates a list of LEdges.

Graph Construction

These functions mirror the construction and destruction functions in Data.Graph.Inductive.Graph, but use the given NodeMap to look up the appropriate Nodes. Note that the insMapNode family of functions will create new nodes as needed, but the other functions will not.

valueinsMapNode

:: (Ord a, DynGraph g)
=> NodeMap a
-> a
-> g a b
-> (g a b, NodeMap a, LNode a)

valueinsMapNode_ :: (Ord a, DynGraph g) => NodeMap a -> a -> g a b -> g a b

valueinsMapEdge

:: (Ord a, DynGraph g)
=> NodeMap a
-> (a, a, b)
-> g a b
-> g a b

Partial function: raises exception if passed nodes that are not in the graph.

valuedelMapNode :: (Ord a, DynGraph g) => NodeMap a -> a -> g a b -> g a b

valuedelMapEdge :: (Ord a, DynGraph g) => NodeMap a -> (a, a) -> g a b -> g a b

Partial function: raises exception if passed nodes that are not in the graph.

valueinsMapNodes

:: (Ord a, DynGraph g)
=> NodeMap a
-> [a]
-> g a b
-> (g a b, NodeMap a, [LNode a])

valueinsMapNodes_ :: (Ord a, DynGraph g) => NodeMap a -> [a] -> g a b -> g a b

valueinsMapEdges

:: (Ord a, DynGraph g)
=> NodeMap a
-> [(a, a, b)]
-> g a b
-> g a b

Partial function: raises exception if passed nodes that are not in the graph.

valuedelMapNodes :: (Ord a, DynGraph g) => NodeMap a -> [a] -> g a b -> g a b

valuedelMapEdges

:: (Ord a, DynGraph g)
=> NodeMap a
-> [(a, a)]
-> g a b
-> g a b

Partial function: raises exception if passed nodes that are not in the graph.

valuemkMapGraph

:: (Ord a, DynGraph g)
=> [a]
-> [(a, a, b)]
-> (g a b, NodeMap a)

Partial function: raises exception if passed a node that is not in the graph.

Monadic Construction

1 declaration

typetype NodeMapM a b (g :: Type -> Type -> Type) r = State (NodeMap a, g a b) r

Graph construction monad; handles passing both the NodeMap and the Graph.

The following mirror the functional construction functions, but handle passing NodeMaps and Graphs behind the scenes.

Map Construction

valuerun

:: (DynGraph g, Ord a)
=> g a b
-> NodeMapM a b g r
-> (r, (NodeMap a, g a b))

Run a construction; return the value of the computation, the modified NodeMap, and the modified Graph.

valuerun_ :: (DynGraph g, Ord a) => g a b -> NodeMapM a b g r -> g a b

Run a construction and only return the Graph.

valuemkNodeM :: Ord a => a -> NodeMapM a b g (LNode a)

Monadic node construction.

valuemkNodesM :: Ord a => [a] -> NodeMapM a b g [LNode a]

valuemkEdgeM :: Ord a => (a, a, b) -> NodeMapM a b g (Maybe (LEdge b))

valuemkEdgesM :: Ord a => [(a, a, b)] -> NodeMapM a b g (Maybe [LEdge b])

Graph Construction

valueinsMapNodeM :: (Ord a, DynGraph g) => a -> NodeMapM a b g (LNode a)

valueinsMapEdgeM :: (Ord a, DynGraph g) => (a, a, b) -> NodeMapM a b g ()

valuedelMapNodeM :: (Ord a, DynGraph g) => a -> NodeMapM a b g ()

valuedelMapEdgeM :: (Ord a, DynGraph g) => (a, a) -> NodeMapM a b g ()

valueinsMapNodesM :: (Ord a, DynGraph g) => [a] -> NodeMapM a b g [LNode a]

valueinsMapEdgesM :: (Ord a, DynGraph g) => [(a, a, b)] -> NodeMapM a b g ()

valuedelMapNodesM :: (Ord a, DynGraph g) => [a] -> NodeMapM a b g ()

valuedelMapEdgesM :: (Ord a, DynGraph g) => [(a, a)] -> NodeMapM a b g ()