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

Interface PairMetric<U>

Type Parameters:
U - Type of the users.
All Known Implementing Classes:
AbstractPairMetric, ClusteringCoefficientIncrement, ComplementaryEmbededness, ComplementaryNeighbourOverlap, ComplementaryPairMetric, Distance, DistanceWithoutLink, EdgeBetweenness, EdgeWeight, Embededness, ExpandedNeighborCountedOverlap, ExpandedNeighborOverlap, Geodesics, NeighbourOverlap, PreferentialAttachment, ReciprocalShortestPathLength, ReciprocityRate, ShrinkingASL, ShrinkingASLNeighbors, ShrinkingDiameter, ShrinkingDiameterNeighbors, Weakness, WeightedNeighborLogOverlap, WeightedNeighborOverlap
public interface PairMetric<U>
Interface for node pair based metrics.

  • 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>> pair, int pairCount)
    Computes the average value of a certain group of pairs.
    double averageValueOnlyLinks​(Graph<U> graph)
    Computes the average value of the metric, restricted to the set of links in the network.
    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
    java.util.function.Function<U,​java.lang.Double> computeDest​(Graph<U> graph, U dest)
    Given a user, computes the value of a metric for all the possible pairs in the graph where the user is the destination.
    java.util.Map<Pair<U>,​java.lang.Double> computeOnlyLinks​(Graph<U> graph)
    Computes the value of the metric for all the links in the graph.
    java.util.function.Function<U,​java.lang.Double> computeOrig​(Graph<U> graph, U orig)
    Given a user, computes the value of a metric for all the possible pairs in the graph where the user is the origin.

  • Method Details

    • compute

      double compute​(Graph<U> graph, U orig, U dest)
      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

      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.
      Parameters:
      graph - The full graph.
      Returns:
      A map containing the metrics for each node.

    • computeOnlyLinks

      java.util.Map<Pair<U>,​java.lang.Double> computeOnlyLinks​(Graph<U> graph)
      Computes the value of the metric for all the links in the graph.
      Parameters:
      graph - the full graph.
      Returns:
      A map containing the metrics for each link.

    • compute

      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.
      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.

    • computeOrig

      java.util.function.Function<U,​java.lang.Double> computeOrig​(Graph<U> graph, U orig)
      Given a user, computes the value of a metric for all the possible pairs in the graph where the user is the origin. As, for efficiency methods, all values might not be computed, the default value of the metric shall be retrieved from the outcome.
      Parameters:
      graph - the graph.
      orig - the origin node.
      Returns:
      the map containing the values of the metric.

    • computeDest

      java.util.function.Function<U,​java.lang.Double> computeDest​(Graph<U> graph, U dest)
      Given a user, computes the value of a metric for all the possible pairs in the graph where the user is the destination. As, for efficiency methods, all values might not be computed, the default value of the metric shall be retrieved from the outcome.
      Parameters:
      graph - the graph.
      dest - the origin node.
      Returns:
      the map containing the values of the metric.

    • averageValue

      double averageValue​(Graph<U> graph)
      Computes the average value of the metric
      Parameters:
      graph - The full graph.
      Returns:
      The average value of the metric

    • averageValueOnlyLinks

      double averageValueOnlyLinks​(Graph<U> graph)
      Computes the average value of the metric, restricted to the set of links in the network.
      Parameters:
      graph - the network.
      Returns:
      the average value of the metric over the links in the network.

    • averageValue

      double averageValue​(Graph<U> graph, java.util.stream.Stream<Pair<U>> pair, int pairCount)
      Computes the average value of a certain group of pairs.
      Parameters:
      graph - the full graph.
      pair - a stream containing the selected pairs.
      pairCount - the number of pairs in the stream.
      Returns:
      The average value of the metric for those pairs.