Skip to main content

A Generalized Suffix Tree for any iterable, with Lowest Common Ancestor retrieval

Project description

A Generalized Suffix Tree for any Python sequence, with Lowest Common Ancestor retrieval.

pip install suffix-tree
>>> from suffix_tree import Tree

>>> tree = Tree({"A": "xabxac"})
>>> tree.find("abx")
>>> tree.find("abc")

This suffix tree:

  • works with any Python sequence, not just strings, if the items are hashable,

  • is a generalized suffix tree for sets of sequences,

  • is implemented in pure Python,

  • builds the tree in linear time with Ukkonen’s algorithm,

  • does constant-time Lowest Common Ancestor retrieval.

Three different builders have been implemented:

  • one that follows Ukkonen’s original paper ([Ukkonen1995]),

  • one that follows Gusfield’s variant ([Gusfield1997]),

  • and one simple naive algorithm.

Being implemented in Python this tree is not very fast nor memory efficient. The building of the tree takes time proportional to the length of the string of symbols. The query time is proportional to the length of the query string. You can get a rough idea of the performance under: Time Complexity. To get the best performance run with python -O.


Usage examples:

>>> tree = Tree()
>>> tree.add(1, "xabxac")
>>> tree.add(2, "awyawxawxz")
>>> tree.find("abx")
>>> tree.find("awx")
>>> tree.find("abc")
>>> tree = Tree({"A": "xabxac", "B": "awyawxawxz"})
>>> tree.find_id("A", "abx")
>>> tree.find_id("B", "abx")
>>> tree.find_id("B", "awx")
>>> tree = Tree(
...     {
...         "A": "sandollar",
...         "B": "sandlot",
...         "C": "handler",
...         "D": "grand",
...         "E": "pantry",
...     }
... )
>>> for k, length, path in tree.common_substrings():
...     print(k, length, path)
2 4 s a n d
3 3 a n d
4 3 a n d
5 2 a n
>>> tree = Tree({"A": "xabxac", "B": "awyawxawxz"})
>>> for C, path in sorted(tree.maximal_repeats()):
...     print(C, path)
1 a w
1 a w x
2 a
2 x
2 x a

Time Complexity




Ukkonen, Esko. On-line construction of suffix trees. 1995. Algorithmica 14:249-60.


Gusfield, Dan. Algorithms on strings, trees, and sequences. 1997. Cambridge University Press.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

suffix_tree-0.1.0.tar.gz (363.7 kB view hashes)

Uploaded source

Built Distribution

suffix_tree-0.1.0-py3-none-any.whl (34.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page