Edge Type

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

Constructors

Constructor Description

Edge()

Full Usage: Edge()

Returns: Edge

Returns: Edge

Static members

Static member Description

Edge.addEdge graph edge

Full Usage: Edge.addEdge graph edge

Parameters:
    graph : DiGraph<'NodeKey, 'NodeData, 'EdgeData> - The graph the edge will be added to.
    edge : 'NodeKey * 'NodeKey * 'EdgeData - The edge to be created. A three part tuple containing the origin node, the destination node, and any edge label such as the weight.

Returns: DiGraph<'NodeKey, 'NodeData, 'EdgeData> Unit

Adds a new edge to the graph

graph : DiGraph<'NodeKey, 'NodeData, 'EdgeData>

The graph the edge will be added to.

edge : 'NodeKey * 'NodeKey * 'EdgeData

The edge to be created. A three part tuple containing the origin node, the destination node, and any edge label such as the weight.

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

Unit

Edge.removeEdge edge graph

Full Usage: Edge.removeEdge edge graph

Parameters:
    edge : 'NodeKey * 'NodeKey - The edge to be removed. A two part tuple containing the origin node, the destination node.
    graph : DiGraph<'NodeKey, 'NodeData, 'EdgeData> - The graph the edge will be removed from.

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

Removes an edge from the graph.

edge : 'NodeKey * 'NodeKey

The edge to be removed. A two part tuple containing the origin node, the destination node.

graph : DiGraph<'NodeKey, 'NodeData, 'EdgeData>

The graph the edge will be removed from.

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

Edge.sumBy getWeight graph

Full Usage: Edge.sumBy getWeight graph

Parameters:
    getWeight : 'EdgeData -> float - Function that maps EdgeData to float.
    graph : DiGraph<'b, 'c, 'EdgeData> - The graph the edge will be removed from.

Returns: float

Sums all Edges according to getWeight.

getWeight : 'EdgeData -> float

Function that maps EdgeData to float.

graph : DiGraph<'b, 'c, 'EdgeData>

The graph the edge will be removed from.

Returns: float