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

Class Distance<U>

java.lang.Object
es.uam.eps.ir.relison.sna.metrics.pair.AbstractPairMetric<U>
es.uam.eps.ir.relison.sna.metrics.distance.pair.Distance<U>
Type Parameters:
U - type of the users.
All Implemented Interfaces:
PairMetric<U>
public class Distance<U>
extends AbstractPairMetric<U>
Computes the distance between nodes.

  • Field Summary

    Fields 
    Modifier and Type Field Description
    private ASLMode aslMode
    Limits the pairs of nodes over which the metric will be averaged.
    private DistanceCalculator<U> dc
    Distance calculator.

  • Constructor Summary

    Constructors 
    Constructor Description
    Distance()
    Constructor.
    Distance​(DistanceCalculator<U> dc)
    Constructor.
    Distance​(DistanceCalculator<U> dc, ASLMode aslMode)
    Constructor.
    Distance​(ASLMode aslMode)
    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>> pairs, int pairCount)
    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

    • dc

      private final DistanceCalculator<U> dc
      Distance calculator.

    • aslMode

      private final ASLMode aslMode
      Limits the pairs of nodes over which the metric will be averaged. By default, values are averaged over pairs at finite distance.

  • Constructor Details

    • Distance

      public Distance​(DistanceCalculator<U> dc)
      Constructor.
      Parameters:
      dc - distance calculator

    • Distance

      public Distance()
      Constructor.

    • Distance

      public Distance​(ASLMode aslMode)
      Constructor.
      Parameters:
      aslMode - limits the pairs of nodes over which the metric will be averaged.

    • Distance

      public Distance​(DistanceCalculator<U> dc, ASLMode aslMode)
      Constructor.
      Parameters:
      dc - distance calculator
      aslMode - limits the pairs of nodes over which the metric will be averaged.

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

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

    • 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>> pairs, int pairCount)
      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.
      pairs - a stream containing the selected pairs.
      pairCount - the number of pairs in the stream.
      Returns:
      The average value of the metric for those pairs.