package ocamlgraph

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Graph structure
Size functions
Membership functions
Successors and predecessors
Graph iterators
Vertex iterators

package ocamlgraph

ocamlgraph
- Graph
  - Blocks
    
    BidirectionalLabeled
    
    E
    
    C
    
    HM
    
    I
    
    S
    
    V
    
    VE
    
    BidirectionalMinimal
    
    HM
    
    BidirectionalUnlabeled
    
    E
    
    HM
    
    I
    
    S
    
    V
    
    ConcreteVertex
    
    F
    
    X
    
    HM
    
    V
    
    Graph
    
    G
    
    E
    
    V
    
    HM
    
    Labeled
    
    E
    
    C
    
    HM
    
    I
    
    S
    
    V
    
    VE
    
    Make
    
    Digraph
    
    Abstract
    
    E
    
    G
    
    E
    
    HM
    
    I
    
    PV
    
    S
    
    HM
    
    I
    
    PE
    
    PV
    
    S
    
    V
    
    AbstractLabeled
    
    E
    
    G
    
    E
    
    C
    
    HM
    
    I
    
    PV
    
    S
    
    VE
    
    HM
    
    I
    
    PE
    
    PV
    
    S
    
    V
    
    Concrete
    
    E
    
    HM
    
    I
    
    PV
    
    S
    
    V
    
    ConcreteBidirectional
    
    E
    
    HM
    
    I
    
    PV
    
    S
    
    V
    
    ConcreteBidirectionalLabeled
    
    E
    
    C
    
    Edge
    
    HM
    
    I
    
    PV
    
    S
    
    V
    
    VE
    
    ConcreteLabeled
    
    E
    
    C
    
    Edge
    
    HM
    
    I
    
    PV
    
    S
    
    V
    
    VE
    
    F
    
    X
    
    Make_Abstract
    
    G
    
    E
    
    HM
    
    V
    
    I
    
    Make_Hashtbl
    
    X
    
    Make_Map
    
    X
    
    Minimal
    
    HM
    
    Pred
    
    S
    
    PE
    
    PV
    
    TBL_BUILDER
    
    X
    
    Unlabeled
    
    E
    
    HM
    
    I
    
    S
    
    V
  - Builder
    
    I
    
    G
    
    E
    
    V
    
    INT
    
    G
    
    E
    
    V
    
    P
    
    G
    
    E
    
    V
    
    S
    
    G
    
    E
    
    V
  - ChaoticIteration
    
    Data
    
    G
    
    E
    
    V
    
    Make
    
    D
    
    G
    
    E
    
    V
  - Classic
    
    I
    
    G
    
    E
    
    V
    
    P
    
    G
    
    E
    
    V
    
    S
  - Clique
    
    Bron_Kerbosch
    
    G
    
    V
    
    G
    
    V
  - Cliquetree
    
    CliqueTree
    
    CliqueTree
    
    E
    
    V
    
    CliqueTreeE
    
    CliqueTreeV
    
    CliqueV
    
    G
    
    E
    
    V
  - Coloring
    
    G
    
    V
    
    GM
    
    Mark
    
    V
    
    Make
    
    G
    
    V
    
    Mark
    
    G
    
    Mark
    
    V
  - Components
    
    BiConnectivity
    
    G
    
    E
    
    V
    
    Connectivity
    
    GB
    
    G
    
    E
    
    V
    
    G
    
    V
    
    Make
    
    G
    
    V
    
    U
    
    V
    
    Undirected
    
    G
    
    V
  - Contraction
    
    G
    
    E
    
    V
    
    Make
    
    G
    
    E
    
    V
  - Cycles
    
    Fashwo
    
    GB
    
    G
    
    E
    
    V
  - DGraphModel
    
    DotG
    
    E
    
    V
    
    Make
    
    G
    
    E
    
    V
    
    model
    
    abstract_model
  - DGraphRandModel
    
    G
    
    E
    
    V
    
    GraphAttrs
    
    E
    
    V
  - DGraphSubTree
    
    G
    
    E
    
    V
    
    Make
    
    G
    
    E
    
    V
    
    Tree
    
    E
    
    V
    
    Make_from_dot_model
    
    Tree
    
    E
    
    V
    
    S
    
    Tree
    
    E
    
    V
    
    Tree
    
    E
    
    V
  - DGraphTreeLayout
    
    Make
    
    Tree
    
    E
    
    V
    
    TreeManipulation
    
    MakeFromDotModel
    
    Tree
    
    E
    
    V
    
    TreeManipulation
  - DGraphTreeModel
    
    S
    
    Tree
    
    E
    
    V
    
    TreeManipulation
    
    tree_model
    
    SubTreeDotModelMake
    
    Tree
    
    E
    
    V
    
    TreeManipulation
    
    tree_model
    
    SubTreeMake
    
    G
    
    E
    
    V
    
    Tree
    
    E
    
    V
    
    TreeManipulation
    
    tree_model
  - Delaunay
    
    CCC
    
    Float
    
    FloatPoints
    
    Int
    
    IntPoints
    
    Make
    
    S
    
    Triangulation
    
    S
  - Dominator
    
    G
    
    V
    
    I
    
    V
    
    Make
    
    G
    
    V
    
    Make_graph
    
    G
    
    V
    
    S
  - Dot
    
    Parse
    
    B
    
    G
    
    E
    
    V
    
    L
  - Dot_ast
  - Fixpoint
    
    Analysis
    
    G
    
    E
    
    V
    
    Make
    
    A
    
    G
    
    E
    
    V
  - Flow
    
    FLOW
    
    FLOWMIN
    
    Ford_Fulkerson
    
    F
    
    G
    
    E
    
    V
    
    G_FORD_FULKERSON
    
    E
    
    V
    
    G_GOLDBERG_TARJAN
    
    E
    
    V
    
    Goldberg_Tarjan
    
    F
    
    G
    
    E
    
    V
  - Gmap
    
    E_DST
    
    E_SRC
    
    E
    
    Edge
    
    G_Dst
    
    G_Src
    
    E
    
    V_DST
    
    V_SRC
    
    V
    
    Vertex
    
    G_Dst
    
    G_Src
    
    V
  - Gml
    
    G
    
    E
    
    V
    
    Parse
    
    B
    
    G
    
    E
    
    V
    
    L
    
    Print
    
    G
    
    E
    
    V
    
    L
  - Graphml
    
    G
    
    E
    
    Print
    
    G
    
    E
    
    L
  - Graphviz
    
    ATTRIBUTES
    
    CommonAttributes
    
    Dot
    
    X
    
    E
    
    V
    
    DotAttributes
    
    GraphWithDotAttrs
    
    E
    
    V
    
    Neato
    
    X
    
    E
    
    V
    
    NeatoAttributes
  - Imperative
    
    Digraph
    
    Abstract
    
    E
    
    Mark
    
    V
    
    AbstractLabeled
    
    E
    
    Mark
    
    V
    
    Concrete
    
    E
    
    V
    
    ConcreteBidirectional
    
    E
    
    V
    
    ConcreteBidirectionalLabeled
    
    E
    
    V
    
    ConcreteLabeled
    
    E
    
    V
    
    Graph
    
    Abstract
    
    E
    
    Mark
    
    V
    
    AbstractLabeled
    
    E
    
    Mark
    
    V
    
    Concrete
    
    E
    
    V
    
    ConcreteLabeled
    
    E
    
    V
    
    Matrix
    
    Digraph
    
    E
    
    V
    
    Graph
    
    E
    
    V
    
    S
    
    E
    
    V
    
    S
    
    Abstract
    
    E
    
    Mark
    
    V
    
    AbstractLabeled
    
    E
    
    Mark
    
    V
    
    Concrete
    
    E
    
    V
    
    ConcreteLabeled
    
    E
    
    V
  - Kruskal
    
    G
    
    E
    
    V
    
    Generic
    
    G
    
    E
    
    V
    
    UF
    
    W
    
    Make
    
    G
    
    E
    
    V
    
    W
    
    UNIONFIND
  - Leaderlist
    
    G
    
    V
    
    Make
    
    G
    
    V
  - Mcs_m
    
    MaximalCardinalitySearch
    
    I
    
    Gr
    
    E
    
    V
    
    P
    
    G
    
    E
    
    V
  - Md
    
    I
    
    G
    
    E
    
    V
    
    P
    
    G
    
    E
    
    V
  - Merge
    
    B
    
    X
    
    G
    
    E
    
    V
    
    I
    
    G
    
    E
    
    V
    
    P
    
    G
    
    E
    
    V
    
    S
  - Mincut
    
    G
    
    V
    
    Make
    
    G
    
    V
  - Minsep
    
    G
    
    V
    
    I
    
    G
    
    Mark
    
    V
    
    MINSEP
    
    G
    
    V
    
    P
    
    G
    
    V
  - Nonnegative
    
    Imperative
    
    G
    
    E
    
    Mark
    
    V
    
    Mark
    
    W
    
    Persistent
    
    G
    
    E
    
    V
    
    W
  - Oper
    
    Choose
    
    G
    
    I
    
    G
    
    E
    
    V
    
    Make
    
    B
    
    G
    
    E
    
    V
    
    Neighbourhood
    
    G
    
    V
    
    P
    
    G
    
    E
    
    V
    
    S
  - Pack
    
    Digraph
    
    Bfs
    
    Classic
    
    Coloring
    
    Components
    
    Dfs
    
    E
    
    Eulerian
    
    Mark
    
    Marking
    
    PathCheck
    
    Rand
    
    Topological
    
    V
    
    Graph
    
    Bfs
    
    Classic
    
    Coloring
    
    Components
    
    Dfs
    
    E
    
    Eulerian
    
    Mark
    
    Marking
    
    PathCheck
    
    Rand
    
    Topological
    
    V
  - Path
    
    BellmanFord
    
    G
    
    E
    
    V
    
    W
    
    Check
    
    G
    
    V
    
    Dijkstra
    
    G
    
    E
    
    V
    
    W
    
    G
    
    E
    
    V
    
    Johnson
    
    G
    
    E
    
    V
    
    W
    
    WJ
  - Persistent
    
    Digraph
    
    Abstract
    
    E
    
    V
    
    AbstractLabeled
    
    E
    
    V
    
    Concrete
    
    E
    
    V
    
    ConcreteBidirectional
    
    E
    
    V
    
    ConcreteBidirectionalLabeled
    
    E
    
    V
    
    ConcreteLabeled
    
    E
    
    V
    
    Graph
    
    Abstract
    
    E
    
    V
    
    AbstractLabeled
    
    E
    
    V
    
    Concrete
    
    E
    
    V
    
    ConcreteLabeled
    
    E
    
    V
    
    S
    
    Abstract
    
    E
    
    V
    
    AbstractLabeled
    
    E
    
    V
    
    Concrete
    
    E
    
    V
    
    ConcreteLabeled
    
    E
    
    V
  - Prim
    
    G
    
    E
    
    V
    
    Make
    
    G
    
    E
    
    V
    
    W
  - Rand
    
    I
    
    G
    
    E
    
    V
    
    Make
    
    B
    
    G
    
    E
    
    V
    
    P
    
    G
    
    E
    
    V
    
    Planar
    
    I
    
    G
    
    E
    
    V
    
    Make
    
    B
    
    G
    
    E
    
    V
    
    P
    
    G
    
    E
    
    V
    
    S
    
    S
  - Sig
    
    ANY_TYPE
    
    COMPARABLE
    
    EDGE
    
    G
    
    E
    
    V
    
    HASHABLE
    
    I
    
    E
    
    V
    
    IM
    
    E
    
    Mark
    
    V
    
    MARK
    
    ORDERED_TYPE
    
    ORDERED_TYPE_DFT
    
    P
    
    E
    
    V
    
    VERTEX
    
    WEIGHT
  - Sig_pack
    
    S
    
    Bfs
    
    Classic
    
    Coloring
    
    Components
    
    Dfs
    
    E
    
    Eulerian
    
    Mark
    
    Marking
    
    PathCheck
    
    Rand
    
    Topological
    
    V
  - Strat
    
    Algo
    
    G
    
    V
    
    P
    
    S
    
    G
    
    V
    
    PLAYER
    
    STRAT
  - Topological
    
    G
    
    V
    
    Make
    
    G
    
    V
    
    Make_stable
    
    G
    
    V
  - Traverse
    
    Bfs
    
    G
    
    V
    
    Dfs
    
    G
    
    V
    
    G
    
    V
    
    GM
    
    Mark
    
    V
    
    Mark
    
    G
    
    Mark
    
    V
  - Util
    
    CMPProduct
    
    X
    
    Y
    
    DataV
    
    L
    
    V
    
    HTProduct
    
    X
    
    Y
    
    Memo
    
    X
    
    OTProduct
    
    X
    
    Y
  - WeakTopological
    
    G
    
    V
    
    Make
    
    G
    
    V
  - XDot
    
    Make
    
    G
    
    E
    
    V
  - XDotDraw

Legend:
Library
Module
Module type
Parameter
Class
Class type

Graph structure

type t

Abstract type of graphs

module V : Sig.VERTEX

Vertices have type V.t and are labeled with type V.label (note that an implementation may identify the vertex with its label)

type vertex = V.t

module E : Sig.EDGE with type vertex = vertex

Edges have type E.t and are labeled with type E.label. src (resp. dst) returns the origin (resp. the destination) of a given edge.

type edge = E.t

val is_directed : bool

Is this an implementation of directed graphs?

Size functions

val is_empty : t -> bool

val nb_vertex : t -> int

val nb_edges : t -> int

Degree of a vertex

val out_degree : t -> vertex -> int

out_degree g v returns the out-degree of v in g.

raises Invalid_argument
if v is not in g.

val in_degree : t -> vertex -> int

in_degree g v returns the in-degree of v in g.

raises Invalid_argument
if v is not in g.

Membership functions

val mem_vertex : t -> vertex -> bool

val mem_edge : t -> vertex -> vertex -> bool

val mem_edge_e : t -> edge -> bool

val find_edge : t -> vertex -> vertex -> edge

find_edge g v1 v2 returns the edge from v1 to v2 if it exists. Unspecified behaviour if g has several edges from v1 to v2.

raises Not_found
if no such edge exists.

val find_all_edges : t -> vertex -> vertex -> edge list

find_all_edges g v1 v2 returns all the edges from v1 to v2.

since ocamlgraph 1.8

Successors and predecessors

You should better use iterators on successors/predecessors (see Section "Vertex iterators").

val succ : t -> vertex -> vertex list

succ g v returns the successors of v in g.

raises Invalid_argument
if v is not in g.

val pred : t -> vertex -> vertex list

pred g v returns the predecessors of v in g.

raises Invalid_argument
if v is not in g.

Labeled edges going from/to a vertex

val succ_e : t -> vertex -> edge list

succ_e g v returns the edges going from v in g.

raises Invalid_argument
if v is not in g.

val pred_e : t -> vertex -> edge list

pred_e g v returns the edges going to v in g.

raises Invalid_argument
if v is not in g.

Graph iterators

val iter_vertex : (vertex -> unit) -> t -> unit

Iter on all vertices of a graph.

val fold_vertex : (vertex -> 'a -> 'a) -> t -> 'a -> 'a

Fold on all vertices of a graph.

val iter_edges : (vertex -> vertex -> unit) -> t -> unit

Iter on all edges of a graph. Edge label is ignored.

val fold_edges : (vertex -> vertex -> 'a -> 'a) -> t -> 'a -> 'a

Fold on all edges of a graph. Edge label is ignored.

val iter_edges_e : (edge -> unit) -> t -> unit

Iter on all edges of a graph.

val fold_edges_e : (edge -> 'a -> 'a) -> t -> 'a -> 'a

Fold on all edges of a graph.

val map_vertex : (vertex -> vertex) -> t -> t

Map on all vertices of a graph.

The current implementation requires the supplied function to be injective. Said otherwise, map_vertex cannot be used to contract a graph by mapping several vertices to the same vertex. To contract a graph, use instead create, add_vertex, and add_edge.

Vertex iterators

Each iterator iterator f v g iters f to the successors/predecessors of v in the graph g and raises Invalid_argument if v is not in g. It is the same for functions fold_* which use an additional accumulator.

<b>Time complexity for ocamlgraph implementations:</b> operations on successors are in O(1) amortized for imperative graphs and in O(ln(|V|)) for persistent graphs while operations on predecessors are in O(max(|V|,|E|)) for imperative graphs and in O(max(|V|,|E|)*ln|V|) for persistent graphs.

iter/fold on all successors/predecessors of a vertex.

val iter_succ : (vertex -> unit) -> t -> vertex -> unit

val iter_pred : (vertex -> unit) -> t -> vertex -> unit

val fold_succ : (vertex -> 'a -> 'a) -> t -> vertex -> 'a -> 'a

val fold_pred : (vertex -> 'a -> 'a) -> t -> vertex -> 'a -> 'a

iter/fold on all edges going from/to a vertex.

val iter_succ_e : (edge -> unit) -> t -> vertex -> unit

val fold_succ_e : (edge -> 'a -> 'a) -> t -> vertex -> 'a -> 'a

val iter_pred_e : (edge -> unit) -> t -> vertex -> unit

val fold_pred_e : (edge -> 'a -> 'a) -> t -> vertex -> 'a -> 'a