C# Class Smrf.NodeXL.Algorithms.OverallReciprocationCalculator

Calculates the reciprocated vertex pair ratio and the reciprocated edge pair ratio for the graph.
The calculations skip all self-loops and duplicate edges, which would render the ratios invalid.
Inheritance: GraphMetricCalculatorBase
Show file Open project: 2014-sed-team3/term-project Class Usage Examples

Public Methods

Method Description
AssertValid ( ) : void
CalculateGraphMetrics ( IGraph graph, Nullable &reciprocatedVertexPairRatio, Nullable &reciprocatedEdgeRatio ) : void
OverallReciprocationCalculator ( ) : System

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

Protected Methods

Method Description
CalculateReciprocatedEdgeRatio ( IGraph oGraph, Int32 iVertexPairsWithBothDirectedEdges ) : Nullable
CalculateReciprocatedVertexPairRatio ( IGraph oGraph, Int32 iVertexPairsWithBothDirectedEdges, HashSet oVertexIDPairsUnordered ) : Nullable
CountEdges ( IGraph oGraph, HashSet &oVertexIDPairsOrdered, HashSet &oVertexIDPairsUnordered ) : void
CountVertexPairsWithBothDirectedEdges ( IGraph oGraph, HashSet oVertexIDPairsOrdered ) : Int32

Method Details

AssertValid() public method

public AssertValid ( ) : void
return void

CalculateGraphMetrics() public method

public CalculateGraphMetrics ( IGraph graph, Nullable &reciprocatedVertexPairRatio, Nullable &reciprocatedEdgeRatio ) : void
graph IGraph
reciprocatedVertexPairRatio Nullable
reciprocatedEdgeRatio Nullable
return void

CalculateReciprocatedEdgeRatio() protected method

protected CalculateReciprocatedEdgeRatio ( IGraph oGraph, Int32 iVertexPairsWithBothDirectedEdges ) : Nullable
oGraph IGraph
iVertexPairsWithBothDirectedEdges System.Int32
return Nullable

CalculateReciprocatedVertexPairRatio() protected method

protected CalculateReciprocatedVertexPairRatio ( IGraph oGraph, Int32 iVertexPairsWithBothDirectedEdges, HashSet oVertexIDPairsUnordered ) : Nullable
oGraph IGraph
iVertexPairsWithBothDirectedEdges System.Int32
oVertexIDPairsUnordered HashSet
return Nullable

CountEdges() protected method

protected CountEdges ( IGraph oGraph, HashSet &oVertexIDPairsOrdered, HashSet &oVertexIDPairsUnordered ) : void
oGraph IGraph
oVertexIDPairsOrdered HashSet
oVertexIDPairsUnordered HashSet
return void

CountVertexPairsWithBothDirectedEdges() protected method

protected CountVertexPairsWithBothDirectedEdges ( IGraph oGraph, HashSet oVertexIDPairsOrdered ) : Int32
oGraph IGraph
oVertexIDPairsOrdered HashSet
return System.Int32

OverallReciprocationCalculator() public method

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

TryCalculateGraphMetrics() public method

public TryCalculateGraphMetrics ( IGraph graph, BackgroundWorker backgroundWorker, Nullable &reciprocatedVertexPairRatio, Nullable &reciprocatedEdgeRatio ) : System.Boolean
graph IGraph
backgroundWorker System.ComponentModel.BackgroundWorker
reciprocatedVertexPairRatio Nullable
reciprocatedEdgeRatio Nullable
return System.Boolean