C# Class Smrf.NodeXL.Algorithms.OverallMetricCalculator

Calculates the overall metrics for the graph.
The calculations for OverallMetrics.GraphDensity, and skip all self-loops and duplicate edges, which would render the metrics invalid.
Inheritance: GraphMetricCalculatorBase
Show file Open project: 2014-sed-team3/term-project

Public Methods

Method Description
AssertValid ( ) : void
CalculateGraphMetrics ( IGraph graph ) : OverallMetrics
OverallMetricCalculator ( ) : System

Initializes a new instance of the class.
TryCalculateGraphMetrics ( IGraph graph, BackgroundWorker backgroundWorker, OverallMetrics &graphMetrics ) : System.Boolean

Protected Methods

Method Description
CalculateConnectedComponentMetrics ( IGraph oGraph, Int32 &iConnectedComponents, Int32 &iSingleVertexConnectedComponents, Int32 &iMaximumConnectedComponentVertices, Int32 &iMaximumConnectedComponentEdges ) : void
CalculateGraphDensity ( IGraph oGraph, Int32 iVertices, Int32 iTotalEdgesAfterMergingDuplicatesNoSelfLoops ) : Nullable
CalculateSnapOverallMetrics ( IGraph oGraph, Nullable &iMaximumGeodesicDistance, Nullable &dAverageGeodesicDistance, Nullable &dModularity ) : void
CountSelfLoops ( IGraph oGraph ) : Int32
CountUniqueEdges ( LinkedList oConnectedComponent ) : Int32

Method Details

AssertValid() public method

public AssertValid ( ) : void
return void

CalculateConnectedComponentMetrics() protected method

protected CalculateConnectedComponentMetrics ( IGraph oGraph, Int32 &iConnectedComponents, Int32 &iSingleVertexConnectedComponents, Int32 &iMaximumConnectedComponentVertices, Int32 &iMaximumConnectedComponentEdges ) : void
oGraph IGraph
iConnectedComponents System.Int32
iSingleVertexConnectedComponents System.Int32
iMaximumConnectedComponentVertices System.Int32
iMaximumConnectedComponentEdges System.Int32
return void

CalculateGraphDensity() protected method

protected CalculateGraphDensity ( IGraph oGraph, Int32 iVertices, Int32 iTotalEdgesAfterMergingDuplicatesNoSelfLoops ) : Nullable
oGraph IGraph
iVertices System.Int32
iTotalEdgesAfterMergingDuplicatesNoSelfLoops System.Int32
return Nullable

CalculateGraphMetrics() public method

public CalculateGraphMetrics ( IGraph graph ) : OverallMetrics
graph IGraph
return OverallMetrics

CalculateSnapOverallMetrics() protected method

protected CalculateSnapOverallMetrics ( IGraph oGraph, Nullable &iMaximumGeodesicDistance, Nullable &dAverageGeodesicDistance, Nullable &dModularity ) : void
oGraph IGraph
iMaximumGeodesicDistance Nullable
dAverageGeodesicDistance Nullable
dModularity Nullable
return void

CountSelfLoops() protected method

protected CountSelfLoops ( IGraph oGraph ) : Int32
oGraph IGraph
return System.Int32

CountUniqueEdges() protected method

protected CountUniqueEdges ( LinkedList oConnectedComponent ) : Int32
oConnectedComponent LinkedList
return System.Int32

OverallMetricCalculator() public method

Initializes a new instance of the class.
public OverallMetricCalculator ( ) : System
return System

TryCalculateGraphMetrics() public method

public TryCalculateGraphMetrics ( IGraph graph, BackgroundWorker backgroundWorker, OverallMetrics &graphMetrics ) : System.Boolean
graph IGraph
backgroundWorker System.ComponentModel.BackgroundWorker
graphMetrics OverallMetrics
return System.Boolean