Added Suffix Tree implementation using Ukkonen algorithm

[CarolLuca]

References to other Issues or PRs or Relevant literature

Brief description of what is fixed or changed

Added suffix tree class

Other comments

May be considered as GSoC 23 work sample

[czgdp1807]

I would recommend to always shift to a new branch (other than main before making a new PR). Right now you have made your PR using your main branch. Keep this PR as is but from next time onwards update your main locally and then switch to a new branch for a new feature/bug fix.

[czgdp1807]

Thanks for this. I have left some reviews. Please address them.

[codecov]

Codecov Report

Merging #524 (b8c6b45) into main (2482adb) will increase coverage by 0.045%.
The diff coverage is 100.000%.

Additional details and impacted files

@@              Coverage Diff              @@
##              main      #524       +/-   ##
=============================================
+ Coverage   98.558%   98.603%   +0.045%     
=============================================
  Files           32        33        +1     
  Lines         4092      4226      +134     
=============================================
+ Hits          4033      4167      +134     
  Misses          59        59               

Impacted Files	Coverage Δ
pydatastructs/strings/__init__.py	100.000% <100.000%> (ø)
pydatastructs/strings/suffix_tree.py	100.000% <100.000%> (ø)
pydatastructs/utils/misc_util.py	99.250% <100.000%> (+0.120%)	⬆️

[czgdp1807]

See, https://app.codecov.io/gh/codezonediitj/pydatastructs/pull/524/blob/pydatastructs/strings/suffix_tree.py. There are lots of lines (see the red ones) which aren't tested.

Also add SuffixTree to the following list,

pydatastructs/pydatastructs/utils/tests/test_code_quality.py

Lines 151 to 177 in 2482adb

	pyds.graphs.adjacency_list.AdjacencyList,
	pyds.graphs.adjacency_matrix.AdjacencyMatrix,
	pyds.DoublyLinkedList, pyds.SinglyLinkedList,
	pyds.SinglyCircularLinkedList,
	pyds.DoublyCircularLinkedList,
	pyds.OneDimensionalArray, pyds.MultiDimensionalArray,
	pyds.DynamicOneDimensionalArray,
	pyds.trees.BinaryTree, pyds.BinarySearchTree,
	pyds.AVLTree, pyds.SplayTree, pyds.BinaryTreeTraversal,
	pyds.DHeap, pyds.BinaryHeap, pyds.TernaryHeap, pyds.BinomialHeap,
	pyds.MAryTree, pyds.OneDimensionalSegmentTree,
	pyds.Queue, pyds.miscellaneous_data_structures.queue.ArrayQueue,
	pyds.miscellaneous_data_structures.queue.LinkedListQueue,
	pyds.PriorityQueue,
	pyds.miscellaneous_data_structures.queue.LinkedListPriorityQueue,
	pyds.miscellaneous_data_structures.queue.BinaryHeapPriorityQueue,
	pyds.miscellaneous_data_structures.queue.BinomialHeapPriorityQueue,
	pyds.Stack, pyds.miscellaneous_data_structures.stack.ArrayStack,
	pyds.miscellaneous_data_structures.stack.LinkedListStack,
	pyds.DisjointSetForest, pyds.BinomialTree, pyds.TreeNode, pyds.MAryTreeNode,
	pyds.LinkedListNode, pyds.BinomialTreeNode, pyds.AdjacencyListGraphNode,
	pyds.AdjacencyMatrixGraphNode, pyds.GraphEdge, pyds.Set, pyds.BinaryIndexedTree,
	pyds.CartesianTree, pyds.CartesianTreeNode, pyds.Treap, pyds.RedBlackTreeNode, pyds.RedBlackTree,
	pyds.Trie, pyds.TrieNode, pyds.SkipList, pyds.RangeQueryStatic, pyds.RangeQueryDynamic, pyds.SparseTable,
	pyds.miscellaneous_data_structures.segment_tree.OneDimensionalArraySegmentTree,
	pyds.bubble_sort, pyds.linear_search, pyds.binary_search, pyds.jump_search,
	pyds.selection_sort, pyds.insertion_sort, pyds.quick_sort]

[CarolLuca]

I followed all the requested changes and added more tests such that the testing covers all the methods and sub-cases. I would be grateful if you could tell me if I can polish the classes in any other way.

[czgdp1807]

Thanks for this. Sorry for the later review. Mostly related to documentation.

[CarolLuca]

Thanks for this. Sorry for the later review. Mostly related to documentation.

I combined the __new__ and __init__ methods successfully, and added documentation for the main class, but also for the auxiliary classes from misc_util.py