Modularity Type

Namespace: Graphoscope.Measures
Assembly: Graphoscope.dll
Base Type: obj

Constructors

Constructor Description

Modularity()

Full Usage: Modularity()

Returns: Modularity

Returns: Modularity

Static members

Static member Description

Modularity.compute (graph, partition, ?getWeight, ?resolution)

Full Usage: Modularity.compute (graph, partition, ?getWeight, ?resolution)

Parameters:
    graph : DiGraph<'NodeKey, 'NodeData, 'EdgeData> - The graph to analyse
    partition : Set<'NodeKey>[] - A sequence of Set of nodes that collectively exhaust all the nodes in thegraph
    ?getWeight : 'EdgeData -> float - Function to get the edge weight from 'EdgeData. Optional; defaults to each edge weight being equal to 1.0.
    ?resolution : float - If resolution is less than 1, modularity favors larger communities. Greater than 1 favors smaller communities. Optional; default = 1.0

Returns: float

Finds the modularity of a given partition of the graph, where partition is a sequence of Set of nodes that collectively exhaust all the nodes in thegraph.

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

The graph to analyse

partition : Set<'NodeKey>[]

A sequence of Set of nodes that collectively exhaust all the nodes in thegraph

?getWeight : 'EdgeData -> float

Function to get the edge weight from 'EdgeData. Optional; defaults to each edge weight being equal to 1.0.

?resolution : float

If resolution is less than 1, modularity favors larger communities. Greater than 1 favors smaller communities. Optional; default = 1.0

Returns: float

Modularity.compute (graph, partition, ?getWeight, ?resolution)

Full Usage: Modularity.compute (graph, partition, ?getWeight, ?resolution)

Parameters:
    graph : UndirectedGraph<'NodeKey, 'NodeData, 'EdgeData> - The graph to analyse
    partition : Set<'NodeKey>[] - A sequence of Set of nodes that collectively exhaust all the nodes in thegraph
    ?getWeight : 'EdgeData -> float - Function to get the edge weight from 'EdgeData. Optional; defaults to each edge weight being equal to 1.0.
    ?resolution : float - If resolution is less than 1, modularity favors larger communities. Greater than 1 favors smaller communities. Optional; default = 1.0

Returns: float

Finds the modularity of a given partition of the graph, where partition is a sequence of Set of nodes that collectively exhaust all the nodes in thegraph.

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

The graph to analyse

partition : Set<'NodeKey>[]

A sequence of Set of nodes that collectively exhaust all the nodes in thegraph

?getWeight : 'EdgeData -> float

Function to get the edge weight from 'EdgeData. Optional; defaults to each edge weight being equal to 1.0.

?resolution : float

If resolution is less than 1, modularity favors larger communities. Greater than 1 favors smaller communities. Optional; default = 1.0

Returns: float

Modularity.ofDiGraph getWeight resolution partition graph

Full Usage: Modularity.ofDiGraph getWeight resolution partition graph

Parameters:
    getWeight : 'EdgeData -> float - Function to get the edge weight from 'EdgeData.
    resolution : float - If resolution is less than 1, modularity favors larger communities. Greater than 1 favors smaller communities.
    partition : Set<'NodeKey>[] - A sequence of Set of nodes that collectively exhaust all the nodes in thegraph
    graph : DiGraph<'NodeKey, 'c, 'EdgeData> - The graph to analyse

Returns: float

Finds the modularity of a given partition of the graph, where partition is a sequence of Set of nodes that collectively exhaust all the nodes in thegraph.

getWeight : 'EdgeData -> float

Function to get the edge weight from 'EdgeData.

resolution : float

If resolution is less than 1, modularity favors larger communities. Greater than 1 favors smaller communities.

partition : Set<'NodeKey>[]

A sequence of Set of nodes that collectively exhaust all the nodes in thegraph

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

The graph to analyse

Returns: float

Modularity.ofUndirectedGraph getWeight resolution partition graph

Full Usage: Modularity.ofUndirectedGraph getWeight resolution partition graph

Parameters:
    getWeight : 'EdgeData -> float - Function to get the edge weight from 'EdgeData.
    resolution : float - If resolution is less than 1, modularity favors larger communities. Greater than 1 favors smaller communities.
    partition : Set<'NodeKey>[] - A sequence of Set of nodes that collectively exhaust all the nodes in thegraph
    graph : UndirectedGraph<'NodeKey, 'c, 'EdgeData> - The graph to analyse

Returns: float

Finds the modularity of a given partition of the graph, where partition is a sequence of Set of nodes that collectively exhaust all the nodes in thegraph.

getWeight : 'EdgeData -> float

Function to get the edge weight from 'EdgeData.

resolution : float

If resolution is less than 1, modularity favors larger communities. Greater than 1 favors smaller communities.

partition : Set<'NodeKey>[]

A sequence of Set of nodes that collectively exhaust all the nodes in thegraph

graph : UndirectedGraph<'NodeKey, 'c, 'EdgeData>

The graph to analyse

Returns: float