Package edu.princeton.cs.algs4

Class SuffixArray

  • public class SuffixArray
extends Object
    The SuffixArray class represents a suffix array of a string of length n. It supports the selecting the ith smallest suffix, getting the index of the ith smallest suffix, computing the length of the longest common prefix between the ith smallest suffix and the i-1st smallest suffix, and determining the rank of a query string (which is the number of suffixes strictly less than the query string).

    This implementation uses a nested class Suffix to represent a suffix of a string (using constant time and space) and Arrays.sort() to sort the array of suffixes. The index and length operations takes constant time in the worst case. The lcp operation takes time proportional to the length of the longest common prefix. The select operation takes time proportional to the length of the suffix and should be used primarily for debugging.

    For alternate implementations of the same API, see SuffixArrayX, which is faster in practice (uses 3-way radix quicksort) and uses less memory (does not create Suffix objects) and SuffixArrayJava6.java, which relies on the constant-time substring extraction method that existed in Java 6.

    For additional documentation, see Section 6.3 of Algorithms, 4th Edition by Robert Sedgewick and Kevin Wayne.

    • Constructor Detail

      • SuffixArray

        public SuffixArray​(String text)
        Initializes a suffix array for the given text string.
        Parameters:
        text - the input string

    • Method Detail

      • length

        public int length()
        Returns the length of the input string.
        Returns:
        the length of the input string

      • index

        public int index​(int i)
        Returns the index into the original string of the ith smallest suffix. That is, text.substring(sa.index(i)) is the ith smallest suffix.
        Parameters:
        i - an integer between 0 and n-1
        Returns:
        the index into the original string of the ith smallest suffix
        Throws:
        IllegalArgumentException - unless 0 <= i < n

      • lcp

        public int lcp​(int i)
        Returns the length of the longest common prefix of the ith smallest suffix and the i-1st smallest suffix.
        Parameters:
        i - an integer between 1 and n-1
        Returns:
        the length of the longest common prefix of the ith smallest suffix and the i-1st smallest suffix.
        Throws:
        IllegalArgumentException - unless 1 <= i < n

      • select

        public String select​(int i)
        Returns the ith smallest suffix as a string.
        Parameters:
        i - the index
        Returns:
        the i smallest suffix as a string
        Throws:
        IllegalArgumentException - unless 0 <= i < n

      • rank

        public int rank​(String query)
        Returns the number of suffixes strictly less than the query string. We note that rank(select(i)) equals i for each i between 0 and n-1.
        Parameters:
        query - the query string
        Returns:
        the number of suffixes strictly less than query

      • main

        public static void main​(String[] args)
        Unit tests the SuffixArray data type.
        Parameters:
        args - the command-line arguments