Package es.uam.eps.ir.relison.sna.metrics.complementary.pair

Class ComplementaryNeighbourOverlap<U>

java.lang.Object

es.uam.eps.ir.relison.sna.metrics.pair.AbstractPairMetric<U>

es.uam.eps.ir.relison.sna.metrics.complementary.pair.ComplementaryNeighbourOverlap<U>

Type Parameters:

U - type of the nodes.

All Implemented Interfaces:

PairMetric<U>

public class ComplementaryNeighbourOverlap<U>
extends AbstractPairMetric<U>

Computes the intersection between the neighborhoods of two nodes in the complementary graph.

Field Summary

Fields

Modifier and Type	Field	Description
private EdgeOrientation	uSel	Neighbour selection for the origin node.
private EdgeOrientation	vSel	Neighbour selection for the destiny node.

Constructor Summary

Constructors

Constructor	Description
ComplementaryNeighbourOverlap()	Default constructor.
ComplementaryNeighbourOverlap(EdgeOrientation uSel, EdgeOrientation vSel)	Constructor.

Method Summary

Modifier and Type	Method	Description
double	averageValue(Graph<U> graph)	Computes the average value of the metric
double	averageValue(Graph<U> graph, java.util.stream.Stream<Pair<U>> edges, int edgeCount)	Computes the average value of a certain group of pairs.
java.util.Map<Pair<U>,java.lang.Double>	compute(Graph<U> graph)	Computes the value of the metric for all the possible pairs in the graph.
java.util.Map<Pair<U>,java.lang.Double>	compute(Graph<U> graph, java.util.stream.Stream<Pair<U>> pairs)	Computes the value of the metric for a selection of pairs in the graph.
double	compute(Graph<U> graph, U orig, U dest)	Computes the value of the metric for a single pair of nodes

Methods inherited from class es.uam.eps.ir.relison.sna.metrics.pair.AbstractPairMetric

averageValueOnlyLinks, computeDest, computeOnlyLinks, computeOrig

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

uSel

private final EdgeOrientation uSel

Neighbour selection for the origin node.

vSel

private final EdgeOrientation vSel

Neighbour selection for the destiny node.

Constructor Details

ComplementaryNeighbourOverlap

public ComplementaryNeighbourOverlap()

Default constructor. Uses the outgoing neighbourhood of the origin node, and the incoming of the destiny one.

ComplementaryNeighbourOverlap

public ComplementaryNeighbourOverlap(EdgeOrientation uSel, EdgeOrientation vSel)

Constructor.

Parameters:

uSel - Neighbour selection for the origin node.

vSel - Neighbour selection for the destiny node.

Method Details

compute

public double compute(Graph<U> graph, U orig, U dest)

Description copied from interface: PairMetric

Computes the value of the metric for a single pair of nodes

Parameters:

graph - The full graph.

orig - The origin node of the edge.

dest - The destiny node of the edge.

Returns:

The value of the metric for that edge.

compute

public java.util.Map<Pair<U>,java.lang.Double> compute(Graph<U> graph)

Description copied from interface: PairMetric

Computes the value of the metric for all the possible pairs in the graph.

Specified by:

compute in interface PairMetric<U>

Overrides:

compute in class AbstractPairMetric<U>

Parameters:

graph - The full graph.

Returns:

A map containing the metrics for each node.

averageValue

public double averageValue(Graph<U> graph)

Description copied from interface: PairMetric

Computes the average value of the metric

Specified by:

averageValue in interface PairMetric<U>

Overrides:

averageValue in class AbstractPairMetric<U>

Parameters:

graph - The full graph.

Returns:

The average value of the metric

averageValue

public double averageValue(Graph<U> graph, java.util.stream.Stream<Pair<U>> edges, int edgeCount)

Description copied from interface: PairMetric

Computes the average value of a certain group of pairs.

Specified by:

averageValue in interface PairMetric<U>

Overrides:

averageValue in class AbstractPairMetric<U>

Parameters:

graph - the full graph.

edges - a stream containing the selected pairs.

edgeCount - the number of pairs in the stream.

Returns:

The average value of the metric for those pairs.

compute

public java.util.Map<Pair<U>,java.lang.Double> compute(Graph<U> graph, java.util.stream.Stream<Pair<U>> pairs)

Description copied from interface: PairMetric

Computes the value of the metric for a selection of pairs in the graph.

Specified by:

compute in interface PairMetric<U>

Overrides:

compute in class AbstractPairMetric<U>

Parameters:

graph - The full graph.

pairs - A stream containing the selected pairs.

Returns:

A map containing the metrics for each pair in the stream that exists.