Edge Type

Namespace: Graphoscope
Assembly: Graphoscope.dll
Parent Module: AdjGraph
Base Type: obj

Functions operating on directed edges

Constructors

Constructor Description

Edge()

Full Usage: Edge()

Returns: Edge

Returns: Edge

Static members

Static member Description

Edge.add sourceKey targetKey data graph

Full Usage: Edge.add sourceKey targetKey data graph

Parameters:
    sourceKey : 'NodeKey
    targetKey : 'NodeKey
    data : 'EdgeData
    graph : AdjGraph<'NodeKey, 'NodeData, 'EdgeData>

Returns: AdjGraph<'NodeKey, 'NodeData, 'EdgeData>

Add edge

sourceKey : 'NodeKey
targetKey : 'NodeKey
data : 'EdgeData
graph : AdjGraph<'NodeKey, 'NodeData, 'EdgeData>
Returns: AdjGraph<'NodeKey, 'NodeData, 'EdgeData>

Edge.count graph

Full Usage: Edge.count graph

Parameters:
    graph : AdjGraph<'NodeKey, 'NodeData, 'EdgeData>

Returns: int

Counts all edges

graph : AdjGraph<'NodeKey, 'NodeData, 'EdgeData>
Returns: int

Edge.find sourceKey targetKey graph

Full Usage: Edge.find sourceKey targetKey graph

Parameters:
    sourceKey : 'NodeKey
    targetKey : 'NodeKey
    graph : AdjGraph<'NodeKey, 'NodeData, 'EdgeData>

Returns: 'NodeKey * 'NodeKey * 'EdgeData

Tries to find an edge between the specified nodes. Raises Exception if no such edge exists in the graph.

sourceKey : 'NodeKey
targetKey : 'NodeKey
graph : AdjGraph<'NodeKey, 'NodeData, 'EdgeData>
Returns: 'NodeKey * 'NodeKey * 'EdgeData

Edge.iter action graph

Full Usage: Edge.iter action graph

Parameters:
    action : 'NodeKey -> 'NodeKey -> 'EdgeData -> unit
    graph : AdjGraph<'NodeKey, 'NodeData, 'EdgeData>

Applies the given function to each node of the graph

action : 'NodeKey -> 'NodeKey -> 'EdgeData -> unit
graph : AdjGraph<'NodeKey, 'NodeData, 'EdgeData>