Class MetricLine

  • Direct Known Subclasses:
    LineMetric

    public class MetricLine
    extends java.lang.Object
    Template interface for metrics on type T.

    A metric is a function that defines a scalar distance between elements.
    • Constructor Summary

      Constructors 
      Constructor Description
      MetricLine​(long cPtr, boolean cMemoryOwn)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void delete()  
      double distance​(Line q)
      The distance from the zero element to q
      double distance​(Line a, Line b)
      The distance from element a to b.
      static long getCPtr​(MetricLine obj)  
      int size()
      The dimension of elements on which this metric operates.

      The returns -1 if the elements don't have a measure of dimension or
      if the metric works for elements of all dimensions.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • MetricLine

        public MetricLine​(long cPtr,
                          boolean cMemoryOwn)
    • Method Detail

      • getCPtr

        public static long getCPtr​(MetricLine obj)
      • delete

        public void delete()
      • distance

        public double distance​(Line q)
        The distance from the zero element to q
      • distance

        public double distance​(Line a,
                               Line b)
        The distance from element a to b.
        Parameters:
        a - [in] first element
        b - [in] second element
        Returns:
        the distance
      • size

        public int size()
        The dimension of elements on which this metric operates.

        The returns -1 if the elements don't have a measure of dimension or
        if the metric works for elements of all dimensions.