simudyne.core.data.graph

Interface GraphMetricsExtractor

public interface GraphMetricsExtractor

A tool to extract the properties of a graph from a source.

The graph has to be provided using a Source.

The properties extracted from the graph are the number of nodes, the number of edges, the degree distribution, the clustering coefficient distribution.

Method Summary

Modifier and Type	Method and Description
static GraphMetricsExtractor	forSource(Source source) Return a GraphMetricsExtractor for the provided source.
static GraphMetricsExtractor	forSource(Source source, java.lang.String fromHeader, java.lang.String toHeader) Return a GraphMetricsExtractor for the provided source.
org.apache.commons.math3.distribution.RealDistribution	getClusteringCoefficientDistribution()
org.apache.commons.math3.distribution.IntegerDistribution	getDegreeDistribution()
int	getNbEdges()
int	getNbNodes()

Method Detail

forSource

static GraphMetricsExtractor forSource(Source source)

Return a GraphMetricsExtractor for the provided source.

Parameters:

source - : the source leading to the graph

Returns:

a GraphMetricsExtractor

forSource

static GraphMetricsExtractor forSource(Source source,
                                       java.lang.String fromHeader,
                                       java.lang.String toHeader)

Return a GraphMetricsExtractor for the provided source.

Parameters:

source - : the source leading to the graph

fromHeader - : the string to use to identify the source (column name)

toHeader - : the string to use to identify the targets (column name)

Returns:

a GraphMetricsExtractor

getNbNodes

int getNbNodes()

getNbEdges

int getNbEdges()

getClusteringCoefficientDistribution

org.apache.commons.math3.distribution.RealDistribution getClusteringCoefficientDistribution()

Returns:

the empirical clustering coefficient distribution of the graph

getDegreeDistribution

org.apache.commons.math3.distribution.IntegerDistribution getDegreeDistribution()

Returns:

the empirical degree distribution of the graph