| Maintainer | [email protected] |
|---|---|
| Safe Haskell | Safe-Infered |
Data.Graph.Analysis.Types
Contents
Description
This module defines the various types and classes utilised by the Graphalyze library.
- data GraphData n e = GraphData {
- graph :: AGr n e
- wantedRootNodes :: NGroup
- directedData :: Bool
- unusedRelationships :: [Rel n e]
- type AGr n e = Gr n e
- type Rel n e = (n, n, e)
- type NGroup = [Node]
- type LNGroup a = [LNode a]
- wantedRoots :: GraphData n e -> LNGroup n
- addRoots :: GraphData n e -> NGroup -> GraphData n e
- addRootsBy :: (LNode n -> Bool) -> GraphData n e -> GraphData n e
- applyAlg :: (AGr n e -> a) -> GraphData n e -> a
- applyDirAlg :: (Bool -> AGr n e -> a) -> GraphData n e -> a
- mergeUnused :: (Ord n, Ord e) => GraphData n e -> GraphData n e
- removeUnused :: GraphData n e -> GraphData n e
- updateGraph :: (AGr a b -> AGr c d) -> GraphData a b -> GraphData c d
- updateGraph' :: (Bool -> AGr a b -> AGr c d) -> GraphData a b -> GraphData c d
- mapAllNodes :: (Ord a, Ord e, Ord b) => (a -> b) -> GraphData a e -> GraphData b e
- mapNodeType :: (Ord a, Ord b, Ord e) => (a -> b) -> (a -> b) -> GraphData a e -> GraphData b e
- class (Ord (Cluster cl), ToGraphID (Cluster cl)) => ClusterLabel cl where
- data GraphID
- data GenCluster a = GC {}
- data PosLabel a = PLabel {}
Graph specialization.
Represents information about the graph being analysed.
Constructors
| GraphData | |
Fields
| |
Functions on GraphData.
wantedRoots :: GraphData n e -> LNGroup nSource
The expected roots in the data to be analysed.
addRoots :: GraphData n e -> NGroup -> GraphData n eSource
Add extra expected root nodes. No checks are made that these
are valid Node values.
addRootsBy :: (LNode n -> Bool) -> GraphData n e -> GraphData n eSource
Use a filtering function to find extra root nodes to add.
applyAlg :: (AGr n e -> a) -> GraphData n e -> aSource
Apply an algorithm to the data to be analysed.
applyDirAlg :: (Bool -> AGr n e -> a) -> GraphData n e -> aSource
mergeUnused :: (Ord n, Ord e) => GraphData n e -> GraphData n eSource
Merge the unusedRelationships into the graph by adding the
appropriate nodes.
removeUnused :: GraphData n e -> GraphData n eSource
Used to set unusedRelationships = []
updateGraph :: (AGr a b -> AGr c d) -> GraphData a b -> GraphData c dSource
Replace the current graph by applying a function to it. To
ensure type safety, removeUnused is applied.
updateGraph' :: (Bool -> AGr a b -> AGr c d) -> GraphData a b -> GraphData c dSource
Replace the current graph by applying a function to it, where the
function depends on whether the graph is directed (True) or
undirected (False). To ensure type safety, removeUnused is
applied.
mapAllNodes :: (Ord a, Ord e, Ord b) => (a -> b) -> GraphData a e -> GraphData b eSource
Apply a function to all the data points.
This might be useful in circumstances where you want to reduce
the data type used to a simpler one, etc. The function is also
applied to the datums in unusedRelationships.
mapNodeType :: (Ord a, Ord b, Ord e) => (a -> b) -> (a -> b) -> GraphData a e -> GraphData b eSource
Apply the first function to nodes in the graph, and the second
function to those unknown datums in unusedRelationships.
As a sample reason for this function, it can be used to apply a
two-part constructor (e.g. Left and Right from Either) to
the nodes such that the wanted and unwanted datums can be
differentiated before calling mergeUnused.
Clustering graphs based on their node labels.
class (Ord (Cluster cl), ToGraphID (Cluster cl)) => ClusterLabel cl whereSource
These types and classes represent useful label types.
The class of outputs of a clustering algorithm. This class is
mainly used for visualization purposes, with the Ord instance
required for grouping. Instances of this class are intended for
use as the label type of graphs.
Methods
cluster :: cl -> Cluster clSource
The cluster the node label belongs in.
nodeLabel :: cl -> NodeLabel clSource
The actual label.
Instances
data GraphID
Graph label types.
data GenCluster a Source
A generic cluster-label type.
Instances
| Eq a => Eq (GenCluster a) | |
| Show a => Show (GenCluster a) | |
| ClusterLabel (GenCluster a) |
Label type for storing node positions. Note that this isn't an
instance of ClusterLabel since there's no clear indication on
which cluster a node belongs to at this stage.