Package edu.gsu.cs.dmlab.distance.dtw.datatypes.interfaces

Interface IAlignmentPath

  • All Known Implementing Classes:
    SeriesWarpPath
    public interface IAlignmentPath
    Interface for classes that hold the warping information for matching points in one series (I) to points in another series (J). Note that there is no guarantee that all points in either series will have a match in the other.
    Author:
    Dustin Kempton, Data Mining Lab, Georgia State University

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addFirst​(int i, int j)
      Method that adds a mapping from a point at index i in series I to a point j in series J at the beginning of the mapping path.
      void addLast​(int i, int j)
      Method that adds a mapping from a pint at index i in series I to a point j in series J at the end of the mapping path.
      ColMajorCell get​(int index)
      Method that gets the mapping of index i (column) to index j (row) at the index position of this mapping path.
      Iterator<ColMajorCell> getMapping()
      Method that gets an iterator for the mappings of index i (column) to index j (row) in this mapping path.
      List<Integer> getMatchingIndexesForI​(int i)
      Method that gets a list of indices for points in series J that are mapped to index i in series I.
      List<Integer> getMatchingIndexesForJ​(int j)
      Method that gets a list of indices for points in series I that are mapped to index j in series J.
      int maxI()
      Method that returns the maximum index in series I that is contained within this mapping.
      int maxJ()
      Method that returns the maximum index in series J that is contained within this mapping.
      int minI()
      Method that returns the minimum index in series I that is contained within this mapping
      int minJ()
      Method that returns the minimum index in series J that is contained within this mapping.
      int size()
      Method that returns the number of point mappings that are contained within this object.

    • Method Detail

      • size

        int size()
        Method that returns the number of point mappings that are contained within this object.
        Returns:
        The number of point mappings in this object

      • minI

        int minI()
        Method that returns the minimum index in series I that is contained within this mapping
        Returns:
        The minimum index of series I contained in this mapping

      • minJ

        int minJ()
        Method that returns the minimum index in series J that is contained within this mapping.
        Returns:
        The minimum index of series J contained in this mapping

      • maxI

        int maxI()
        Method that returns the maximum index in series I that is contained within this mapping.
        Returns:
        The maximum index in series I contained in this mapping

      • maxJ

        int maxJ()
        Method that returns the maximum index in series J that is contained within this mapping.
        Returns:
        The maximum index in series J contained in this mapping

      • addFirst

        void addFirst​(int i,
              int j)
        Method that adds a mapping from a point at index i in series I to a point j in series J at the beginning of the mapping path. Both i and j must be an index that is lower than or equal to indexes that were used as the previous first entry in the mapping.
        Parameters:
        i - Index of series I that is to be mapped
        j - Index of series J that is to be mapped

      • addLast

        void addLast​(int i,
             int j)
        Method that adds a mapping from a pint at index i in series I to a point j in series J at the end of the mapping path. Both i and j must be an indexes that is greater than or equal to indexes that were used as the previous last entry in the mapping.
        Parameters:
        i - Index of series I that is to be mapped
        j - Index of series J that is to be mapped

      • getMatchingIndexesForI

        List<Integer> getMatchingIndexesForI​(int i)
        Method that gets a list of indices for points in series J that are mapped to index i in series I. Index i must be mapped to at least 1 point in J, otherwise an exception is thrown.
        Parameters:
        i - Index in series I to get matching mapped indices in series J for
        Returns:
        List of indices in J that are mapped to the input index of I

      • getMatchingIndexesForJ

        List<Integer> getMatchingIndexesForJ​(int j)
        Method that gets a list of indices for points in series I that are mapped to index j in series J. Index j must be mapped to at least 1 point in I, otherwise an exception is thrown.
        Parameters:
        j - Index in series J to get matching mapped indices in series I for
        Returns:
        List of indices in I that are mapped to the input index of J

      • get

        ColMajorCell get​(int index)
        Method that gets the mapping of index i (column) to index j (row) at the index position of this mapping path.
        Parameters:
        index - The index in the mapping path to return the mapping for
        Returns:
        The mapping of index i (column) to index j (row) at the indicated index position of this mapping path

      • getMapping

        Iterator<ColMajorCell> getMapping()
        Method that gets an iterator for the mappings of index i (column) to index j (row) in this mapping path.
        Returns:
        An iterator of the mappings of index i (column) to index j (row)